Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Steph Prince <[email protected]>
  • Loading branch information
oruebel and stephprince authored Aug 26, 2024
1 parent 760772f commit 62fc6f7
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/pages/devdocs/documentation.dox
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
* 2. Enable building the docs by setting the cmake variable ``BUILD_DOCS=ON``, e.g.,
* by calling ``cmake --preset=dev -DBUILD_DOCS=ON``
*
* 3. Build the documentation by running: ``cmake --build --preset=dev --target=docs``
* 3. Build the documentation by running: ``cmake --build --preset=dev --target=docs``. The resulting documentation files can be found in your build directory ``build/dev/docs/html``.
*
* \note
* To edit settings in cmake (e.g., to enable ``BUILD_DOCS=ON``) after the initial configuration,
Expand Down Expand Up @@ -48,8 +48,8 @@
* First we need to define our code example by creating a new ``cpp`` file
* in the ``tests/examples`` folder. Here we use the file ``test_examples.cpp`` shown below.
* The file looks like a regular unit test with the addition of Doxygen comments of the form
* `// [example_hdf5io_code_snippet]`` to mark regions in the code that we want to include
* in the docs as code sinppets.
* ``// [example_hdf5io_code_snippet]`` to mark regions in the code that we want to include
* in the docs as code snippets.
*
* \par test_example.cpp
* \snippet tests/examples/test_example.cpp example_all
Expand All @@ -71,7 +71,7 @@
* object we use:
*
* \code{.sh}
* \snippet tests/examples/test_example.cpp example_hdf5io_code_snippet``
* \snippet tests/examples/test_example.cpp example_hdf5io_code_snippet
* \endcode
*
* which displays as follows in the docs:
Expand All @@ -84,7 +84,7 @@
*
* \section dev_docs_graphviz_sec Creating Custom Dot Graphs
*
* AqNWB uses [Graphviz](https://graphviz.org/) to improve the quality of
* AqNWB uses [Graphviz](https://graphviz.org/) to improve the quality of
* the UML diagrams generated by [Doxygen](https://www.doxygen.nl/). With this, we
* can also generate custom figures using `dot`, simply by including the corresponding
* dot code directly in the doxygen file. For example:
Expand Down

0 comments on commit 62fc6f7

Please sign in to comment.