-
Notifications
You must be signed in to change notification settings - Fork 63
Description
Currently, our doxygen documentation ignores some functions. For example, it does not include static functions only defined in a source file without being declared in a header.
This (a) leads to an incomplete documentation, (b) means that the github workflow does not warn about these kind of functions and (c) may cause problems e.g. when using \ref to refer to some locally-defined helper function.
We can tell doxygen to include these functions by setting: EXTRACT_PRIVATE = YES, EXTRACT_PRIV_VIRTUAL = YES, EXTRACT_STATIC = YES, and/or EXTRACT_LOCAL_METHODS = YES.
However, if we set all of the above, we end up facing yet another set of doxygen errors (136 lines), see below. It seems to be mostly about missing documentation of the then newly included functions.
Nevertheless, I suggest we eradicate all these errors, e.g., in the next t8code week...
/localdata1/spen_th/t8code_dir/t8code/src/t8.c:30: error: Member t8_package_id (variable) of file t8.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8.c:31: error: Member external_log_fcn)(int category, int priority, const char *msg) (variable) of file t8.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh.cxx:77: error: Member t8_cmesh_check_trees_per_eclass(t8_cmesh_t cmesh) (function) of file t8_cmesh.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh.cxx:562: error: Member t8_cmesh_init_profile(t8_cmesh_t cmesh) (function) of file t8_cmesh.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh.cxx:1172: error: Member t8_cmesh_reset(t8_cmesh_t *pcmesh) (function) of file t8_cmesh.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh.cxx:1626: error: Member t8_cmesh_uniform_bounds_from_unpartioned(const t8_cmesh_t cmesh, const t8_gloidx_t local_num_children, const int level, const t8_scheme *scheme, t8_gloidx_t *first_local_tree, t8_gloidx_t *child_in_tree_begin, t8_gloidx_t *last_local_tree, t8_gloidx_t *child_in_tree_end, int8_t *first_tree_shared) (function) of file t8_cmesh.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh.cxx:1888: error: Member t8_cmesh_uniform_bounds_from_partition(const t8_cmesh_t cmesh, const t8_gloidx_t local_num_children, const int level, const t8_scheme *scheme, t8_gloidx_t *first_local_tree, t8_gloidx_t *child_in_tree_begin, t8_gloidx_t *last_local_tree, t8_gloidx_t *child_in_tree_end, int8_t *first_tree_shared, sc_MPI_Comm comm) (function) of file t8_cmesh.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_commit.cxx:55: error: Member t8_ghost_facejoins_compare(const void *fj1, const void *fj2) (function) of file t8_cmesh_commit.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_commit.cxx:64: error: Member t8_ghost_facejoin_equal(const void *v1, const void *v2, const void *u) (function) of file t8_cmesh_commit.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_commit.cxx:77: error: Member t8_ghost_hash(const void *v, const void *u) (function) of file t8_cmesh_commit.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_commit.cxx:86: error: Member t8_cmesh_set_shmem_type(sc_MPI_Comm comm) (function) of file t8_cmesh_commit.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_commit.cxx:94: error: Member t8_cmesh_add_attributes(const t8_cmesh_t cmesh, sc_hash_t *ghost_ids) (function) of file t8_cmesh_commit.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_commit.cxx:137: error: Member t8_cmesh_commit_replicated_new(t8_cmesh_t cmesh) (function) of file t8_cmesh_commit.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_commit.cxx:201: error: Member t8_cmesh_commit_partitioned_new(t8_cmesh_t cmesh, sc_MPI_Comm comm) (function) of file t8_cmesh_commit.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_offset.c:33: error: Member t8_glo_kl0(const t8_gloidx_t A) (function) of file t8_cmesh_offset.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_offset.c:87: error: Member t8_offset_valid_tree(const t8_gloidx_t gtree, const int mpisize, const t8_gloidx_t *offset) (function) of file t8_cmesh_offset.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_offset.c:245: error: Member t8_offset_next_prev_owner_of_tree(const int mpisize, const t8_gloidx_t gtree, const t8_gloidx_t *offset, const int current_owner, const int search_dir) (function) of file t8_cmesh_offset.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx:44: error: Member t8_cmesh_partition_send_change_neighbor(const t8_cmesh_t cmesh, const t8_cmesh_t cmesh_from, t8_locidx_t *neighbor, const int to_proc) (function) of file t8_cmesh_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx:81: error: Member t8_partition_new_ghost_ids(const t8_cmesh_t cmesh, const t8_part_tree_t recv_part, const t8_locidx_t first_ghost, const int proc) (function) of file t8_cmesh_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx:186: error: Member t8_cmesh_gather_treecount_ext(const t8_cmesh_t cmesh, sc_MPI_Comm comm, const int check_commit) (function) of file t8_cmesh_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx:256: error: Member t8_cmesh_partition_sendrange(const t8_cmesh_t cmesh, const t8_cmesh_t cmesh_from, int *send_first, int *send_last) (function) of file t8_cmesh_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx:406: error: Member t8_cmesh_partition_recvrange(const t8_cmesh_t cmesh, const t8_cmesh_t cmesh_from, int *recv_first, int *recv_last) (function) of file t8_cmesh_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx:464: error: Member t8_partition_compute_gnb(const t8_cmesh_t cmesh_from, sc_array_t *send_as_ghost) (function) of file t8_cmesh_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx:492: error: Member t8_partition_compute_gab(const t8_cmesh_t cmesh_from, sc_array_t *send_as_ghost, size_t *attr_info_bytes) (function) of file t8_cmesh_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx:532: error: Member t8_cmesh_send_ghost(const t8_cmesh_t cmesh, const struct t8_cmesh *cmesh_from, const int p, const t8_locidx_t tree) (function) of file t8_cmesh_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx:652: error: Member t8_cmesh_partition_copy_data(char *send_buffer, t8_cmesh_t cmesh, const t8_cmesh *cmesh_from, const t8_locidx_t num_trees, const size_t attr_info_bytes, const size_t ghost_attr_info_bytes, const size_t ghost_neighbor_bytes, const size_t tree_neighbor_bytes, const size_t tree_attribute_bytes, sc_array_t *send_as_ghost, const t8_locidx_t send_first, const t8_locidx_t send_last, const size_t total_alloc, const int to_proc) (function) of file t8_cmesh_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx:909: error: Member t8_cmesh_partition_sendtreeloop(t8_cmesh_t cmesh, const t8_cmesh *cmesh_from, const t8_locidx_t range_start, const t8_locidx_t range_end, size_t *tree_neighbor_bytes, size_t *attr_bytes, size_t *attr_info_bytes, int8_t *ghost_flag_send, const int iproc, sc_array_t *send_as_ghost) (function) of file t8_cmesh_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx:971: error: Member t8_cmesh_partition_sendloop(t8_cmesh_t cmesh, t8_cmesh_t cmesh_from, int *num_request_alloc, int *send_first, int *send_last, char ***send_buffer, char **my_buffer, size_t *my_buffer_bytes, sc_MPI_Request **requests, sc_MPI_Comm comm) (function) of file t8_cmesh_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx:1249: error: Member t8_cmesh_partition_recvloop(t8_cmesh_t cmesh, const t8_cmesh *cmesh_from, const t8_gloidx_t *tree_offset, char *my_buffer, size_t my_buffer_bytes, sc_MPI_Comm comm, int fr, int lr) (function) of file t8_cmesh_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx:1399: error: Member t8_cmesh_partition_debug_listprocs(const t8_cmesh_t cmesh, const t8_cmesh_t cmesh_from, sc_MPI_Comm comm, int *fs, int *ls, int *fr, int *lr) (function) of file t8_cmesh_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_partition.cxx:1449: error: Member t8_cmesh_partition_given(const t8_cmesh_t cmesh, const t8_cmesh_t cmesh_from, const t8_gloidx_t *tree_offset, sc_MPI_Comm comm) (function) of file t8_cmesh_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_stash.c:81: error: Member t8_stash_class_compare(const void *c1, const void *c2) (function) of file t8_cmesh_stash.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_stash.c:99: error: Member t8_stash_class_compare_index(const void *index, const void *c) (function) of file t8_cmesh_stash.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_stash.c:137: error: Member t8_stash_facejoin_compare(const void *j1, const void *j2) (function) of file t8_cmesh_stash.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_stash.c:215: error: Member t8_stash_attribute_compare(const void *v1, const void *v2) (function) of file t8_cmesh_stash.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_stash.c:239: error: Member t8_stash_bcast_attributes(sc_array_t *attributes, const int root, sc_MPI_Comm comm) (function) of file t8_cmesh_stash.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.cxx:45: error: Member t8_cmesh_trees_glo_lo_hash_func(const void *v, const void *u) (function) of file t8_cmesh_trees.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.cxx:54: error: Member t8_cmesh_trees_glo_lo_hash_equal(const void *v1, const void *v2, const void *u) (function) of file t8_cmesh_trees.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.cxx:158: error: Member t8_cmesh_trees_get_num_procs(t8_cmesh_trees_t trees) (function) of file t8_cmesh_trees.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.cxx:169: error: Member t8_part_tree_get_tree(const t8_part_tree_t P, const t8_locidx_t tree_id) (function) of file t8_cmesh_trees.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.cxx:177: error: Member t8_part_tree_get_ghost(t8_part_tree_t P, t8_locidx_t ghost_id) (function) of file t8_cmesh_trees.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.cxx:254: error: Member t8_cmesh_allocate_ghost_num_atts_array(t8_locidx_t part_num_ghosts) (function) of file t8_cmesh_trees.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.cxx:446: error: Member t8_cmesh_trees_neighbor_bytes(const t8_ctree_t tree) (function) of file t8_cmesh_trees.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.cxx:456: error: Member t8_cmesh_trees_gneighbor_bytes(const t8_cghost_t tree) (function) of file t8_cmesh_trees.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.cxx:497: error: Member t8_cmesh_trees_get_part_alloc(const t8_cmesh_trees_t trees, const t8_part_tree_t part) (function) of file t8_cmesh_trees.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.cxx:807: error: Member t8_cmesh_trees_compare_keyattr(const void *A1, const void *A2) (function) of file t8_cmesh_trees.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_internal/t8_cmesh_trees.cxx:994: error: Member t8_cmesh_trees_ghost_id(const t8_cmesh_t cmesh, const t8_cmesh_trees_t trees, const t8_gloidx_t gghost_id) (function) of file t8_cmesh_trees.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_readmshfile.cxx:322: error: Member t8_cmesh_check_version_of_msh_file(FILE *fp) (function) of file t8_cmesh_readmshfile.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_readmshfile.cxx:401: error: Member t8_msh_file_2_read_nodes(FILE *fp) (function) of file t8_cmesh_readmshfile.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_readmshfile.cxx:484: error: Member t8_msh_file_4_read_nodes(FILE *fp) (function) of file t8_cmesh_readmshfile.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_readmshfile.cxx:1429: error: Member t8_cmesh_msh_file_4_read_eles(t8_cmesh_t cmesh, FILE *fp, const t8_msh_node_table vertices, const int dim, const t8_geometry_c *linear_geometry_base, const int use_cad_geometry, const t8_geometry_c *cad_geometry_base, const bool store_node_data) (function) of file t8_cmesh_readmshfile.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_readmshfile.cxx:1646: error: Member t8_msh_file_face_hash(const void *face, const void *data) (function) of file t8_cmesh_readmshfile.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_readmshfile.cxx:1663: error: Member t8_msh_file_face_equal(const void *facea, const void *faceb, const void *data) (function) of file t8_cmesh_readmshfile.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_readmshfile.cxx:1695: error: Member t8_msh_file_face_free(void **face, const void *data) (function) of file t8_cmesh_readmshfile.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_readmshfile.cxx:1708: error: Member t8_msh_file_face_set_boundary(void **face, const void *data) (function) of file t8_cmesh_readmshfile.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_readmshfile.cxx:1727: error: Member t8_msh_file_face_orientation(const t8_msh_file_face_t *Face_a, const t8_msh_file_face_t *Face_b, const t8_eclass_t tree_class_a, const t8_eclass_t tree_class_b) (function) of file t8_cmesh_readmshfile.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_readmshfile.cxx:1782: error: Member t8_cmesh_msh_file_find_neighbors(t8_cmesh_t cmesh, const t8_msh_tree_vertex_indices vertex_indices) (function) of file t8_cmesh_readmshfile.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_readmshfile.cxx:1881: error: Member t8_cmesh_from_msh_file_register_geometries(t8_cmesh_t cmesh, const int use_cad_geometry, const char *fileprefix, const t8_geometry_c **linear_geometry, const t8_geometry_c **cad_geometry) (function) of file t8_cmesh_readmshfile.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx:57: error: Member t8_cmesh_save_ghost_neighbors(const t8_cmesh_t cmesh, FILE *fp) (function) of file t8_cmesh_save.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx:86: error: Member t8_cmesh_load_ghost_attributes(const t8_cmesh_t cmesh, FILE *fp) (function) of file t8_cmesh_save.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx:116: error: Member t8_cmesh_save_ghosts(const t8_cmesh_t cmesh, FILE *fp) (function) of file t8_cmesh_save.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx:135: error: Member t8_cmesh_load_ghosts(const t8_cmesh_t cmesh, FILE *fp) (function) of file t8_cmesh_save.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx:173: error: Member t8_cmesh_load_tree_attributes(const t8_cmesh_t cmesh, FILE *fp) (function) of file t8_cmesh_save.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx:240: error: Member t8_cmesh_save_tree_attribute(const t8_cmesh_t cmesh, FILE *fp) (function) of file t8_cmesh_save.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx:306: error: Member t8_cmesh_save_trees(const t8_cmesh_t cmesh, FILE *fp) (function) of file t8_cmesh_save.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx:343: error: Member t8_cmesh_load_trees(const t8_cmesh_t cmesh, FILE *fp) (function) of file t8_cmesh_save.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx:383: error: Member t8_cmesh_save_header(const t8_cmesh_t cmesh, FILE *fp) (function) of file t8_cmesh_save.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx:440: error: Member t8_cmesh_load_header(const t8_cmesh_t cmesh, FILE *fp) (function) of file t8_cmesh_save.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx:661: error: Member t8_cmesh_load_proc_loads(const int mpirank, const int mpisize, const int num_files, sc_MPI_Comm comm, const t8_load_mode_t mode, int *file_to_load, int num_procs_per_node) (function) of file t8_cmesh_save.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_io/t8_cmesh_save.cxx:743: error: Member t8_cmesh_load_bigger_nonloading(const int mpirank, const int mpisize, const int num_files, const t8_load_mode_t mode, sc_MPI_Comm comm, const int num_procs_per_node) (function) of file t8_cmesh_save.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_data/t8_containers.cxx:36: error: Member t8_element_array_is_valid(const t8_element_array_t *element_array) (function) of file t8_containers.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_data/t8_shmem.c:49: error: Member t8_shmem_array_is_writing_possible(const t8_shmem_array_t array) (function) of file t8_shmem.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest.cxx:516: error: Member t8_forest_element_line_length(t8_forest_t forest, t8_locidx_t ltreeid, const t8_element_t *element, int corner_a, int corner_b) (function) of file t8_forest.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest.cxx:533: error: Member t8_forest_element_triangle_area(double coordinates[3][3]) (function) of file t8_forest.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest.cxx:552: error: Member t8_forest_element_tet_volume(const double coordinates[4][3]) (function) of file t8_forest.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest.cxx:878: error: Member t8_four_points_coplanar(const double p_0[3], const double p_1[3], const double p_2[3], const double p_3[3], const double tolerance) (function) of file t8_forest.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest.cxx:1239: error: Member t8_forest_tree_shared(t8_forest_t forest, int first_or_last) (function) of file t8_forest.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest.cxx:2074: error: Member t8_forest_element_find_owner_compare(const void *find_owner_data, const void *process) (function) of file t8_forest.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest.cxx:2368: error: Member t8_forest_element_owners_at_face_recursion(t8_forest_t forest, t8_gloidx_t gtreeid, const t8_element_t *element, t8_eclass_t eclass, int face, sc_array_t *owners, int lower_bound, int upper_bound, t8_element_t *first_desc, t8_element_t *last_desc) (function) of file t8_forest.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest.cxx:2721: error: Member t8_forest_set_mpicomm(t8_forest_t forest, sc_MPI_Comm mpicomm, int do_dup) (function) of file t8_forest.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest.cxx:3313: error: Member t8_forest_compute_cmesh_offset(t8_forest_t forest, sc_MPI_Comm comm) (function) of file t8_forest.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest.cxx:3463: error: Member t8_forest_compare_elem_tree(const void *lelement_id, const void *ltree) (function) of file t8_forest.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest.cxx:4079: error: Member t8_forest_free_trees(t8_forest_t forest) (function) of file t8_forest.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest.cxx:4109: error: Member t8_forest_reset(t8_forest_t *pforest) (function) of file t8_forest.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_netcdf.cxx:465: error: Member t8_forest_write_netcdf_coordinate_dimension(t8_forest_netcdf_context_t *context, t8_forest_netcdf_ugrid_namespace_t *namespace_context) (function) of file t8_forest_netcdf.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:50: error: Member t8_forest_partition_first_element(const t8_gloidx_t *offset, int rank) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:57: error: Member t8_forest_partition_last_element(const t8_gloidx_t *offset, int rank) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:64: error: Member t8_forest_partition_empty(const t8_gloidx_t *offset, int rank) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:75: error: Member t8_forest_compute_first_local_element_id(t8_forest_t forest) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:172: error: Member t8_forest_partition_test_desc(t8_forest_t forest) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:477: error: Member t8_forest_partition_compute_new_offset(t8_forest_t forest) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:548: error: Member t8_forest_partition_owner_of_element(const int mpisize, const int mpirank, const t8_gloidx_t gelement, const t8_gloidx_t *offset) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:559: error: Member t8_forest_partition_recvrange(t8_forest_t forest, int *recv_first, int *recv_last) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:583: error: Member t8_forest_partition_sendrange(t8_forest_t forest, int *send_first, int *send_last) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:617: error: Member t8_forest_partition_tree_first_last_el(t8_tree_t tree, t8_locidx_t tree_id, t8_locidx_t first_element_send, t8_locidx_t last_element_send, t8_locidx_t current_tree, t8_locidx_t *first_tree_el, t8_locidx_t *last_tree_el) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:665: error: Member t8_forest_partition_fill_buffer(t8_forest_t forest_from, char **send_buffer, int *buffer_alloc, t8_locidx_t *current_tree, t8_locidx_t first_element_send, t8_locidx_t last_element_send) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:760: error: Member t8_forest_partition_fill_buffer_data(t8_forest_t forest_from, char **send_buffer, int *buffer_alloc, t8_locidx_t first_element_send, t8_locidx_t last_element_send, const sc_array_t *data) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:796: error: Member t8_forest_partition_sendloop(t8_forest_t forest, const int send_first, const int send_last, sc_MPI_Request **requests, int *num_request_alloc, char ***send_buffer, const int send_data, const sc_array_t *data_in, size_t *byte_to_self) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:940: error: Member t8_forest_partition_recv_message_data(t8_forest_t forest, sc_MPI_Comm comm, int proc, sc_MPI_Status *status, t8_locidx_t *last_loc_elem_recvd, sc_array_t *data_out, char *sent_to_self, size_t byte_to_self) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:1004: error: Member t8_forest_partition_recv_message(t8_forest_t forest, sc_MPI_Comm comm, int proc, sc_MPI_Status *status, int prev_recvd, char *sent_to_self, size_t byte_to_self) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:1139: error: Member t8_forest_partition_recvloop(t8_forest_t forest, int recv_first, int recv_last, const int recv_data, sc_array_t *data_out, char *sent_to_self, size_t byte_to_self) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_forest/t8_forest_partition.cxx:1195: error: Member t8_forest_partition_given(t8_forest_t forest, const int send_data, const sc_array_t *data_in, sc_array_t *data_out) (function) of file t8_forest_partition.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_geometry/t8_geometry_implementations/t8_geometry_examples.cxx:100: error: Member t8_geom_evaluate_sphere_tri_prism(const double *active_tree_vertices, const t8_eclass_t eclass, const double *ref_coords, const size_t num_coords, double *out_coords) (function) of file t8_geometry_examples.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_geometry/t8_geometry_implementations/t8_geometry_linear.cxx:62: error: Member t8_four_points_coplanar(const t8_3D_vec p_0, const t8_3D_vec p_1, const t8_3D_vec p_2, const t8_3D_vec p_3, const double tolerance) (function) of file t8_geometry_linear.cxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_schemes/t8_default/t8_default_common/t8_default_common.hxx:83: error: Member count_leaves_from_level(const int element_level, const int refinement_level, const int dimension) (function) of file t8_default_common.hxx is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_schemes/t8_default/t8_default_tri/t8_dtri_bits.c:41: error: Member compute_cubeid(const t8_dtri_t *element, int level) (function) of file t8_dtri_bits.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_schemes/t8_default/t8_default_tri/t8_dtri_bits.c:69: error: Member compute_type_ext(const t8_dtri_t *element, int level, t8_dtri_type_t known_type, int known_level) (function) of file t8_dtri_bits.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_schemes/t8_default/t8_default_tri/t8_dtri_bits.c:98: error: Member compute_type(const t8_dtri_t *element, int level) (function) of file t8_dtri_bits.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_schemes/t8_default/t8_default_tri/t8_dtri_bits.c:1387: error: Member t8_dtri_linear_id_first_desc(const t8_dtri_t *element, int level) (function) of file t8_dtri_bits.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_schemes/t8_default/t8_default_tri/t8_dtri_bits.c:1396: error: Member t8_dtri_linear_id_last_desc(const t8_dtri_t *element, int level) (function) of file t8_dtri_bits.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_schemes/t8_default/t8_default_tri/t8_dtri_bits.c:1418: error: Member t8_dtri_linear_id_corner_desc(const t8_dtri_t *element, int corner, int level) (function) of file t8_dtri_bits.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_schemes/t8_default/t8_default_tri/t8_dtri_bits.c:1583: error: Member t8_dtri_succ_pred_recursion(const t8_dtri_t *element, t8_dtri_t *s, int level, int increment) (function) of file t8_dtri_bits.c is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_vertex_connectivity/t8_cmesh_vertex_conn_tree_to_vertex.hxx:172: error: Member state (enumeration) of class t8_cmesh_vertex_conn_tree_to_vertex is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_vertex_connectivity/t8_cmesh_vertex_conn_tree_to_vertex.hxx:173: error: Documentation for enum member 't8_cmesh_vertex_conn_tree_to_vertex::state::EMPTY' is missing.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_vertex_connectivity/t8_cmesh_vertex_conn_tree_to_vertex.hxx:174: error: Documentation for enum member 't8_cmesh_vertex_conn_tree_to_vertex::state::FILLED' is missing.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_vertex_connectivity/t8_cmesh_vertex_conn_tree_to_vertex.hxx:184: error: Member current_state (variable) of class t8_cmesh_vertex_conn_tree_to_vertex is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_vertex_connectivity/t8_cmesh_vertex_conn_vertex_to_tree.hxx:230: error: Documentation for enum member 't8_cmesh_vertex_conn_vertex_to_tree::@277377177006157140157276001300342004360027063315::INITIALIZED' is missing.
/localdata1/spen_th/t8code_dir/t8code/src/t8_cmesh/t8_cmesh_vertex_connectivity/t8_cmesh_vertex_conn_vertex_to_tree.hxx:231: error: Documentation for enum member 't8_cmesh_vertex_conn_vertex_to_tree::@277377177006157140157276001300342004360027063315::COMMITTED' is missing.
/localdata1/spen_th/t8code_dir/t8code/src/t8_schemes/t8_default/t8_default_common/t8_default_common.hxx:94: error: Member TUnderlyingEclassScheme (variable) of class t8_default_scheme_common is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_geometry/t8_geometry_implementations/t8_geometry_analytic.hxx:181: error: Member tree_data (variable) of struct t8_geometry_analytic is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_schemes/t8_scheme_builder.hxx:74: error: Member scheme (variable) of class t8_scheme_builder is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_types/t8_type.hxx:120: error: Member value_ (variable) of class T8Type is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_vtk/t8_vtk_writer.hxx:576: error: Member write_treeid (variable) of class vtk_writer is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_vtk/t8_vtk_writer.hxx:577: error: Member write_mpirank (variable) of class vtk_writer is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_vtk/t8_vtk_writer.hxx:578: error: Member write_level (variable) of class vtk_writer is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_vtk/t8_vtk_writer.hxx:579: error: Member write_element_id (variable) of class vtk_writer is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_vtk/t8_vtk_writer.hxx:580: error: Member write_ghosts (variable) of class vtk_writer is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_vtk/t8_vtk_writer.hxx:581: error: Member curved_flag (variable) of class vtk_writer is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_vtk/t8_vtk_writer.hxx:582: error: Member fileprefix (variable) of class vtk_writer is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_vtk/t8_vtk_writer.hxx:583: error: Member num_data (variable) of class vtk_writer is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_vtk/t8_vtk_writer.hxx:584: error: Member data (variable) of class vtk_writer is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_vtk/t8_vtk_writer.hxx:585: error: Member comm (variable) of class vtk_writer is not documented.
/localdata1/spen_th/t8code_dir/t8code/src/t8_vtk/t8_vtk_writer.hxx:586: error: Member merge_points (variable) of class vtk_writer is not documented.
/localdata1/spen_th/t8code_dir/t8code/mesh_handle/element.hxx:66: error: Member SelfType (typedef) of class t8_mesh_handle::element is not documented.
/localdata1/spen_th/t8code_dir/t8code/mesh_handle/element.hxx:82: error: Member vertex_cache_exists (variable) of class t8_mesh_handle::element is not documented.
/localdata1/spen_th/t8code_dir/t8code/mesh_handle/element.hxx:96: error: Member centroid_cache_exists (variable) of class t8_mesh_handle::element is not documented.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status