diff --git a/src/t8_cmesh/t8_cmesh_examples.h b/src/t8_cmesh/t8_cmesh_examples.h index 96a691b762..66bb1303b8 100644 --- a/src/t8_cmesh/t8_cmesh_examples.h +++ b/src/t8_cmesh/t8_cmesh_examples.h @@ -77,7 +77,7 @@ t8_cmesh_new_empty (sc_MPI_Comm comm, const int do_partition, const int dimensio t8_cmesh_t t8_cmesh_new_from_class (t8_eclass_t eclass, sc_MPI_Comm comm); -/** Construct a hypercube forest from one primitive tree class. +/** Construct a hypercube cmesh from one primitive tree class. * \param [in] eclass This element class determines the dimension and * the number of trees needed to construct a cube. * \param [in] comm The mpi communicator to be used. @@ -92,7 +92,7 @@ t8_cmesh_new_from_class (t8_eclass_t eclass, sc_MPI_Comm comm); t8_cmesh_t t8_cmesh_new_hypercube (t8_eclass_t eclass, sc_MPI_Comm comm, int do_bcast, int do_partition, int periodic); -/** Construct a hypercube forest from one primitive tree class. +/** Construct a hypercube cmesh from one primitive tree class. * \param [in] eclass This element class determines the dimension of the cube. * \param [in] comm The mpi communicator to be used. * \param [in] boundary The vertices, that define the hypercube boundary. @@ -131,7 +131,7 @@ t8_cmesh_t t8_cmesh_new_hypercube_pad (const t8_eclass_t eclass, sc_MPI_Comm comm, const double *boundary, t8_locidx_t polygons_x, t8_locidx_t polygons_y, t8_locidx_t polygons_z, const int use_axis_aligned); -/** Construct a hypercube forest from one primitive tree class. +/** Construct a hypercube cmesh from one primitive tree class. * \param [in] eclass This element class determines the dimension of the cube. * \param [in] comm The mpi communicator to be used. * \param [in] boundary The vertices, that define the hypercube boundary. @@ -190,7 +190,7 @@ t8_cmesh_new_hypercube_hybrid (sc_MPI_Comm comm, int do_partition, int periodic) * Hypercube? * TODO: redundant, remove. * \param [in] comm The mpi communicator to use. - * \param [in] dim The dimension of the forest, 1, 2 or 3. + * \param [in] dim The dimension of the cmesh, 1, 2 or 3. * \return A valid cmesh, as if _init and _commit had been called. */ t8_cmesh_t @@ -228,14 +228,14 @@ t8_cmesh_new_periodic_line_more_trees (sc_MPI_Comm comm); t8_cmesh_t t8_cmesh_new_bigmesh (t8_eclass_t eclass, int num_trees, sc_MPI_Comm comm); -/** Construct a forest of three connected askew lines +/** Construct a cmesh of three connected askew lines * \param [in] comm The mpi communicator to use. * \return A valid cmesh, as if _init and _commit had been called. */ t8_cmesh_t t8_cmesh_new_line_zigzag (sc_MPI_Comm comm); -/** Construct a forest of num_of_prisms connected prism, all with one edge in 0, +/** Construct a cmesh of num_of_prisms connected prism, all with one edge in 0, * except for num_of_prisms = 2, then the return is the hypercube mesh * \param [in] comm The mpi communicator to use. * \param [in] num_of_prisms The number of prisms to be used. @@ -256,14 +256,14 @@ t8_cmesh_new_prism_deformed (sc_MPI_Comm comm); t8_cmesh_t t8_cmesh_new_pyramid_deformed (sc_MPI_Comm comm); -/** Construct a forest of six connected noncannoical oriented prisms +/** Construct a cmesh of six connected noncannoical oriented prisms * \param [in] comm The mpi communicator to use. * \return A valid cmesh, as if _init and _commit had been called. */ t8_cmesh_t t8_cmesh_new_prism_cake_funny_oriented (sc_MPI_Comm comm); -/** Construct a forest of six connected noncannoical oriented prisms +/** Construct a cmesh of six connected noncannoical oriented prisms * \param [in] comm The mpi communicator to use. * \return A valid cmesh, as if _init and _commit had been called. */ diff --git a/src/t8_cmesh/t8_cmesh_geometry.hxx b/src/t8_cmesh/t8_cmesh_geometry.hxx index 7bbaee6178..12760b51ed 100644 --- a/src/t8_cmesh/t8_cmesh_geometry.hxx +++ b/src/t8_cmesh/t8_cmesh_geometry.hxx @@ -22,7 +22,6 @@ /** \file t8_cmesh_geometry.hxx * Internal functions that we need for the cmesh geometry. - * TODO: document this file */ #ifndef T8_CMESH_GEOMETRY_H diff --git a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_commit.cxx b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_commit.cxx index 3c4442b552..e9d8ebb3a9 100644 --- a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_commit.cxx +++ b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_commit.cxx @@ -21,8 +21,7 @@ */ /** \file t8_cmesh_commit.cxx - * - * TODO: document this file + * Functionality to commit a cmesh. */ #include diff --git a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_copy.c b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_copy.c index fb060fa295..25e52c4320 100644 --- a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_copy.c +++ b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_copy.c @@ -21,8 +21,7 @@ */ /** \file t8_cmesh_copy.c - * - * TODO: document this file + * Functionality to copy a cmesh. */ #include diff --git a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_copy.h b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_copy.h index 6f6abcf9f6..cc49313b3f 100644 --- a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_copy.h +++ b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_copy.h @@ -21,8 +21,7 @@ */ /** \file t8_cmesh_copy.h - * - * TODO: document this file + * Function to copy a cmesh. */ #ifndef T8_CMESH_COPY_H diff --git a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_offset.c b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_offset.c index d81d81cf47..f47e4bff68 100644 --- a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_offset.c +++ b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_offset.c @@ -21,8 +21,8 @@ */ /** \file t8_cmesh_offset.c - * - * TODO: document this file + * Implementation of functions that deal with + * the cmesh partition offset. */ #include "t8_cmesh_offset.h" diff --git a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_offset.h b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_offset.h index 552c186ae9..5673ba2607 100644 --- a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_offset.h +++ b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_offset.h @@ -21,11 +21,8 @@ */ /** \file t8_cmesh_offset.h - * - * In this file we collect function that deal with + * In this file we collect functions that deal with * the cmesh partition offset. - * - * TODO: document this file */ #ifndef T8_CMESH_OFFSET_H diff --git a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx index 318f9dcffa..4c93390693 100644 --- a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx +++ b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx @@ -21,8 +21,7 @@ */ /** \file t8_cmesh_partition.cxx - * - * TODO: document this file + * Implementation of functionality related to the partitioning of a cmesh. */ #include diff --git a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.h b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.h index 389fc02e00..3245a8ab0b 100644 --- a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.h +++ b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.h @@ -21,8 +21,7 @@ */ /** \file t8_cmesh_partition.h - * - * TODO: document this file + * Functionality related to the partitioning of a cmesh. */ #ifndef T8_CMESH_PARTITION_H diff --git a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.cxx b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.cxx index fdc9f653e8..230ae9f8d4 100644 --- a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.cxx +++ b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.cxx @@ -21,8 +21,7 @@ */ /** \file t8_cmesh_trees.cxx - * - * TODO: document this file + * Interface for the data layout of the coarse trees. */ #include diff --git a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.h b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.h index 7bb651e428..4f63ada558 100644 --- a/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.h +++ b/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.h @@ -21,8 +21,7 @@ */ /** \file t8_cmesh_trees.h - * - * TODO: document this file + * Interface for the data layout of the coarse trees. */ #ifndef T8_CMESH_PART_TREE_H diff --git a/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx b/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx index 20f481a6cc..a9d7aaa037 100644 --- a/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx +++ b/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx @@ -21,10 +21,7 @@ */ /** \file t8_cmesh_save.cxx - * * We define routines to save and load a cmesh to/from the file system. - * - * TODO: document this file */ #include diff --git a/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.h b/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.h index bd8a4157a9..f071a9dd29 100644 --- a/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.h +++ b/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.h @@ -21,10 +21,7 @@ */ /** \file t8_cmesh_save.h - * * We define routines to save and load a cmesh to/from the file system. - * - * TODO: document this file */ #ifndef T8_CMESH_SAVE_H diff --git a/src/t8_forest/t8_forest_private.h b/src/t8_forest/t8_forest_private.h index e6c3228920..e01f2a5162 100644 --- a/src/t8_forest/t8_forest_private.h +++ b/src/t8_forest/t8_forest_private.h @@ -33,8 +33,6 @@ T8_EXTERN_C_BEGIN (); -/* TODO: document */ - /** Check whether or not \a elements contains a (in)complete family and * return the size of it or zero if no family is considered. * \param [in] forest The forest.