diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 5a0dc8225d..0a0b6a5f6b 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -983,7 +983,8 @@ WARN_LOGFILE = INPUT = @top_srcdir@/src \ @top_srcdir@/mesh_handle \ - @top_srcdir@/test + @top_srcdir@/test \ + @top_srcdir@/tutorials/mesh_handle # This tag can be used to specify the character encoding of the source files # that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/scripts/configure_for_rtd.sh b/scripts/configure_for_rtd.sh index c728d4ee62..af4001e252 100755 --- a/scripts/configure_for_rtd.sh +++ b/scripts/configure_for_rtd.sh @@ -44,7 +44,8 @@ if [ "$READTHEDOCS" = "True" ]; then fi echo "Configuring Doxygen for ReadTheDocs: Excluding source files." # Exclude source files from documentation - echo "EXCLUDE_PATTERNS += *.c *.cc *.cpp *.cxx" >> "$DOXYFILE_PATH" + echo "EXCLUDE_PATTERNS += */src/*.c */src/*.cc */src/*.cpp */src/*.cxx" >> "$DOXYFILE_PATH" + echo "EXCLUDE_PATTERNS += */test/*.c */test/*.cc */test/*.cpp */test/*.cxx" >> "$DOXYFILE_PATH" fi cmake .. -DT8CODE_BUILD_DOCUMENTATION=ON -DT8CODE_BUILD_DOCUMENTATION_SPHINX=ON -DT8CODE_ENABLE_MPI=OFF diff --git a/tutorials/mesh_handle/t8_mesh_element_data.cxx b/tutorials/mesh_handle/t8_mesh_element_data.cxx index 03249f0002..bda3186d1d 100644 --- a/tutorials/mesh_handle/t8_mesh_element_data.cxx +++ b/tutorials/mesh_handle/t8_mesh_element_data.cxx @@ -36,7 +36,7 @@ #include #include -/* The data that we want to store for each element. +/** The data that we want to store for each element. * In this example we want to store the element's level and volume. */ struct data_per_element_type { @@ -139,8 +139,8 @@ exchange_ghost_data_mesh (TMeshClass &mesh) * and T8_VTK_VECTOR - 3 doubles per element * \tparam TMeshClass The mesh handle class. * \param [in] mesh The mesh handle. - * \param [in] fileprefix The prefix of the files where the vtk will be stored. - * The master file is then fileprefix.pvtu and the process with rank r writes in the file fileprefix_r.vtu + * \param [in] prefix The prefix of the files where the vtk will be stored. + * The master file is then prefix.pvtu and the process with rank r writes in the file prefix_r.vtu */ template static void