Skip to content

Feature: Add doxygen docu and check to mesh handle tutorials #2391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lenaploetzke wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −5
Open

Feature: Add doxygen docu and check to mesh handle tutorials #2391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion doc/Doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion scripts/configure_for_rtd.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions tutorials/mesh_handle/t8_mesh_element_data.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
#include <memory>
#include <span>

/* 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
{
Expand Down Expand Up @@ -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 <t8_mesh_handle::T8MeshType TMeshClass>
static void
Expand Down
Loading