songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Revert "fix not documented warnings" 

This reverts commit 8d773c56348c4055d963c57426d60d118915d22b.
This commit is contained in:
Sébastien Loriot 2022-09-23 14:04:51 +02:00
parent 6397378bdc
commit d191d4474a
13 changed files with 287 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/doc/resources/1.8.13/BaseDoxyfile.in
View File

@ -352,9 +352,7 @@ ALIASES = "cgal=%CGAL" \
"cgalParamNEnd=</ul> \htmlonly[block] </div> \endhtmlonly </td><td></td></tr>" \
"cgalParamSectionBegin{1}=\cgalParamNBegin{\1}" \
"cgalParamSectionEnd=\cgalParamNEnd" \
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>"\
"cgalEmptyDoc=&nbsp;"
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>"
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"

3
Documentation/doc/resources/1.8.14/BaseDoxyfile.in
View File

@ -353,8 +353,7 @@ ALIASES = "cgal=%CGAL" \
"cgalParamNEnd=</ul> \htmlonly[block] </div> \endhtmlonly </td><td></td></tr>" \
"cgalParamSectionBegin{1}=\cgalParamNBegin{\1}" \
"cgalParamSectionEnd=\cgalParamNEnd" \
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>" \
"cgalEmptyDoc=&nbsp;"
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>"
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For

4
Documentation/doc/resources/1.8.20/BaseDoxyfile.in
View File

@ -375,8 +375,8 @@ ALIASES = "cgal=%CGAL" \
"cgalParamNEnd=</ul> \htmlonly[block] </div> \endhtmlonly </td><td></td></tr>" \
"cgalParamSectionBegin{1}=\cgalParamNBegin{\1}" \
"cgalParamSectionEnd=\cgalParamNEnd" \
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>" \
"cgalEmptyDoc=&nbsp;"
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>"
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For

2
Documentation/doc/resources/1.8.4/BaseDoxyfile.in
View File

@ -359,7 +359,7 @@ ALIASES+= "cgalParamNEnd=</ul> \htmlonly[block] </div> \endhtmlonly </td><td></t
ALIASES+= "cgalParamSectionBegin{1}=\cgalParamNBegin{\1}"
ALIASES+= "cgalParamSectionEnd=\cgalParamNEnd"
ALIASES+= "cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>"
ALIASES+= "cgalEmptyDoc=&nbsp;"
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding

3
Documentation/doc/resources/1.9.3/BaseDoxyfile.in
View File

@ -375,8 +375,7 @@ ALIASES = "cgal=%CGAL" \
"cgalParamNEnd=</ul> \htmlonly[block] </div> \endhtmlonly </td><td></td></tr>" \
"cgalParamSectionBegin{1}=\cgalParamNBegin{\1}" \
"cgalParamSectionEnd=\cgalParamNEnd" \
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>" \
"cgalEmptyDoc=&nbsp;"
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>"
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For

6
Mesh_3/doc/Mesh_3/CGAL/Implicit_to_labeling_function_wrapper.h
View File

@ -27,8 +27,10 @@ class Implicit_multi_domain_to_labeling_function_wrapper
public:
/// \name Types
/// @{
typedef std::vector<Function*> Function_vector; //!< \cgalEmptyDoc
typedef typename Function::Point Point_3; //!< \cgalEmptyDoc
//!
typedef std::vector<Function*> Function_vector;
//!
typedef typename Function::Point Point_3;
/// @}
/// \name Creation

65
Mesh_3/doc/Mesh_3/Concepts/BisectionGeometricTraits_3.h
View File

@ -184,17 +184,60 @@ typedef unspecified_type Has_on_bounded_side_3;
/// The following functions give access to the predicate and construction objects:
/// @{
Compute_scalar_product_3 compute_scalar_product_3_object(); //!< \cgalEmptyDoc
Compute_squared_distance_3 compute_squared_distance_3_object(); //!< \cgalEmptyDoc
Compute_squared_radius_3 compute_squared_radius_3_object(); //!< \cgalEmptyDoc
Construct_center_3 construct_center_3_object(); //!< \cgalEmptyDoc
Construct_midpoint_3 construct_midpoint_3_object(); //!< \cgalEmptyDoc
Construct_point_on_3 construct_point_on_3_object(); //!< \cgalEmptyDoc
Construct_scaled_vector_3 construct_scaled_vector_3_object(); //!< \cgalEmptyDoc
Construct_segment_3 construct_segment_3_object(); //!< \cgalEmptyDoc
Construct_translated_point_3 construct_translated_point_3_object(); //!< \cgalEmptyDoc
Construct_vector_3 construct_vector_3_object(); //!< \cgalEmptyDoc
Has_on_bounded_side_3 has_on_bounded_side_3_object(); //!< \cgalEmptyDoc
/*!
*/
Compute_scalar_product_3 compute_scalar_product_3_object();
/*!
*/
Compute_squared_distance_3 compute_squared_distance_3_object();
/*!
*/
Compute_squared_radius_3 compute_squared_radius_3_object();
/*!
*/
Construct_center_3 construct_center_3_object();
/*!
*/
Construct_midpoint_3 construct_midpoint_3_object();
/*!
*/
Construct_point_on_3 construct_point_on_3_object();
/*!
*/
Construct_scaled_vector_3 construct_scaled_vector_3_object();
/*!
*/
Construct_segment_3 construct_segment_3_object();
/*!
*/
Construct_translated_point_3 construct_translated_point_3_object();
/*!
*/
Construct_vector_3 construct_vector_3_object();
/*!
*/
Has_on_bounded_side_3 has_on_bounded_side_3_object();
/// @}

43
Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h
View File

@ -177,15 +177,42 @@ The class should provide storage, accessors and modificators for two `Vertex_han
and two `Cell_handle`, and a cache value for sliverity.*/
/// @{
/*!
*/
void set_sliver_value(double value);
/*!
*/
double sliver_value() const;
/*!
*/
bool is_cache_valid() const;
/*!
*/
void reset_cache_validity() const;
/*!
*/
Cell_handle next_intrusive() const;
/*!
*/
void set_next_intrusive(Cell_handle);
/*!
*/
Cell_handle previous_intrusive() const;
/*!
*/
void set_previous_intrusive(Cell_handle);
void set_sliver_value(double value); //!< \cgalEmptyDoc
double sliver_value() const; //!< \cgalEmptyDoc
bool is_cache_valid() const; //!< \cgalEmptyDoc
void reset_cache_validity() const; //!< \cgalEmptyDoc
Cell_handle next_intrusive() const; //!< \cgalEmptyDoc
void set_next_intrusive(Cell_handle); //!< \cgalEmptyDoc
Cell_handle previous_intrusive() const; //!< \cgalEmptyDoc
void set_previous_intrusive(Cell_handle); //!< \cgalEmptyDoc
/// @}

23
Mesh_3/doc/Mesh_3/Concepts/MeshDomain_3.h
View File

@ -189,10 +189,25 @@ Bbox_3 bbox() const;
/// The following functions give access to the function objects:
/// @{
Construct_initial_points construct_initial_points_object(); //!< \cgalEmptyDoc
Is_in_domain is_in_domain_object(); //!< \cgalEmptyDoc
Do_intersect_surface do_intersect_surface_object(); //!< \cgalEmptyDoc
Construct_intersection construct_intersection_object(); //!< \cgalEmptyDoc
/*!
*/
Construct_initial_points construct_initial_points_object();
/*!
*/
Is_in_domain is_in_domain_object();
/*!
*/
Do_intersect_surface do_intersect_surface_object();
/*!
*/
Construct_intersection construct_intersection_object();
/// @}

155
Mesh_3/doc/Mesh_3/Concepts/MeshTriangulationTraits_3.h
View File

@ -328,32 +328,135 @@ public:
/// The following functions give access to the predicate and construction objects:
/// @{
Do_intersect_3 do_intersect_3_object(); //!< \cgalEmptyDoc
Equal_3 equal_3_object(); //!< \cgalEmptyDoc
Is_degenerate_3 equal_3_object(); //!< \cgalEmptyDoc
Compare_weighted_squared_radius_3 compare_weighted_squared_radius_3_object(); //!< \cgalEmptyDoc
Compute_approximate_dihedral_angle_3 compute_approximate_dihedral_angle_3_object(); //!< \cgalEmptyDoc
Compute_area_3 compute_area_3_object(); //!< \cgalEmptyDoc
Compute_power_distance_to_power_sphere_3 compute_power_distance_to_power_sphere_3_object(); //!< \cgalEmptyDoc
Compute_squared_area_3 compute_squared_area_3_object(); //!< \cgalEmptyDoc
Compute_squared_distance_3 compute_squared_distance_3_object(); //!< \cgalEmptyDoc
Compute_squared_length_3 compute_squared_length_3_object(); //!< \cgalEmptyDoc
Compute_squared_radius_3 compute_squared_radius_3_object(); //!< \cgalEmptyDoc
Compute_squared_radius_smallest_orthogonal_sphere_3 compute_squared_radius_smallest_orthogonal_sphere_3_object(); //!< \cgalEmptyDoc
Compute_volume_3 compute_volume_3_object(); //!< \cgalEmptyDoc
Compute_weight_3 compute_weight_3_object(); //!< \cgalEmptyDoc
Construct_base_vector_3 construct_base_vector_3_object(); //!< \cgalEmptyDoc
Construct_orthogonal_vector_3 construct_orthogonal_vector_3_object(); //!< \cgalEmptyDoc
Construct_center_3 construct_center_3_object(); //!< \cgalEmptyDoc
Construct_midpoint_3 construct_midpoint_3_object(); //!< \cgalEmptyDoc
Construct_normal_3 construct_normal_3_object(); //!< \cgalEmptyDoc
Construct_sphere_3 construct_sphere_3_object(); //!< \cgalEmptyDoc
Construct_tetrahedron_3 construct_tetrahedron_3_object(); //!< \cgalEmptyDoc
Construct_translated_point_3 construct_translated_point_3_object(); //!< \cgalEmptyDoc
Construct_vector_3 construct_vector_3_object(); //!< \cgalEmptyDoc
Construct_scaled_vector_3 construct_scaled_vector_3_object(); //!< \cgalEmptyDoc
Construct_opposite_vector_3 construct_opposite_vector_3_object(); //!< \cgalEmptyDoc
Intersect_3 intersect_3_object(); //!< \cgalEmptyDoc
/*!
*/
Do_intersect_3 do_intersect_3_object();
/*!
*/
Equal_3 equal_3_object();
/*!
*/
Is_degenerate_3 equal_3_object();
/*!
*/
Compare_weighted_squared_radius_3 compare_weighted_squared_radius_3_object();
/*!
*/
Compute_approximate_dihedral_angle_3 compute_approximate_dihedral_angle_3_object();
/*!
*/
Compute_area_3 compute_area_3_object();
/*!
*/
Compute_power_distance_to_power_sphere_3 compute_power_distance_to_power_sphere_3_object();
/*!
*/
Compute_squared_area_3 compute_squared_area_3_object();
/*!
*/
Compute_squared_distance_3 compute_squared_distance_3_object();
/*!
*/
Compute_squared_length_3 compute_squared_length_3_object();
/*!
*/
Compute_squared_radius_3 compute_squared_radius_3_object();
/*!
*/
Compute_squared_radius_smallest_orthogonal_sphere_3 compute_squared_radius_smallest_orthogonal_sphere_3_object();
/*!
*/
Compute_volume_3 compute_volume_3_object();
/*!
*/
Compute_weight_3 compute_weight_3_object();
/*!
*/
Construct_base_vector_3 construct_base_vector_3_object();
/*!
*/
Construct_orthogonal_vector_3 construct_orthogonal_vector_3_object();
/*!
*/
Construct_center_3 construct_center_3_object();
/*!
*/
Construct_midpoint_3 construct_midpoint_3_object();
/*!
*/
Construct_normal_3 construct_normal_3_object();
/*!
*/
Construct_sphere_3 construct_sphere_3_object();
/*!
*/
Construct_tetrahedron_3 construct_tetrahedron_3_object();
/*!
*/
Construct_translated_point_3 construct_translated_point_3_object();
/*!
*/
Construct_vector_3 construct_vector_3_object();
/*!
*/
Construct_scaled_vector_3 construct_scaled_vector_3_object();
/*!
*/
Construct_opposite_vector_3 construct_opposite_vector_3_object();
/*!
*/
Intersect_3 intersect_3_object();
/// @}

35
Mesh_3/doc/Mesh_3/Concepts/MeshVertexBase_3.h
View File

@ -91,12 +91,35 @@ Sets the special aspect of the vertex.
*/
void set_special(bool);
FT meshing_info() const; //!< \cgalEmptyDoc
void set_meshing_info(FT); //!< \cgalEmptyDoc
Vertex_handle next_intrusive() const; //!< \cgalEmptyDoc
void set_next_intrusive(Vertex_handle); //!< \cgalEmptyDoc
Vertex_handle previous_intrusive() const; //!< \cgalEmptyDoc
void set_previous_intrusive(Vertex_handle); //!< \cgalEmptyDoc
/*!
*/
FT meshing_info() const;
/*!
*/
void set_meshing_info(FT);
/*!
*/
Vertex_handle next_intrusive() const;
/*!
*/
void set_next_intrusive(Vertex_handle);
/*!
*/
Vertex_handle previous_intrusive() const;
/*!
*/
void set_previous_intrusive(Vertex_handle);
/// Get the erase counter.
/// Only required by the parallel algorithms.

16
Mesh_3/include/CGAL/Mesh_domain_with_polyline_features_3.h
View File

@ -536,20 +536,19 @@ class Mesh_domain_with_polyline_features_3
public:
/// \name Types
/// @{
typedef typename MeshDomain_3::Surface_patch_index Surface_patch_index; //!< \cgalEmptyDoc
typedef typename MeshDomain_3::Subdomain_index Subdomain_index; //!< \cgalEmptyDoc
typedef int Curve_index; //!< \cgalEmptyDoc
typedef int Corner_index; //!< \cgalEmptyDoc
typedef typename MeshDomain_3::Surface_patch_index Surface_patch_index;
typedef typename MeshDomain_3::Subdomain_index Subdomain_index;
typedef int Curve_index;
typedef int Corner_index;
/// \cgalEmptyDoc
typedef typename Mesh_3::internal::Index_generator_with_features<
typename MeshDomain_3::Subdomain_index,
Surface_patch_index,
Curve_index,
Corner_index>::type Index;
typedef CGAL::Tag_true Has_features; //!< \cgalEmptyDoc
typedef typename MeshDomain_3::R::FT FT; //!< \cgalEmptyDoc
typedef CGAL::Tag_true Has_features;
typedef typename MeshDomain_3::R::FT FT;
/// @}
#ifndef DOXYGEN_RUNNING
@ -568,7 +567,6 @@ public:
/// of the base class.
/// @{
/// \cgalEmptyDoc
template <typename ... T>
Mesh_domain_with_polyline_features_3(const T& ...o)
: MeshDomain_3(o...)
@ -576,7 +574,7 @@ public:
, current_curve_index_(1)
, curves_aabb_tree_is_built(false) {}
Mesh_domain_with_polyline_features_3(const Mesh_domain_with_polyline_features_3&) = default; //!< \cgalEmptyDoc
Mesh_domain_with_polyline_features_3(const Mesh_domain_with_polyline_features_3&) = default;
/// @}

8
Mesh_3/include/CGAL/Polyhedral_complex_mesh_domain_3.h
View File

@ -138,10 +138,10 @@ public:
/// \name Index types
/// @{
/// The types are `int` or types compatible with `int`.
typedef typename Base::Corner_index Corner_index; //!< \cgalEmptyDoc
typedef typename Base::Curve_index Curve_index; //!< \cgalEmptyDoc
typedef typename Base::Surface_patch_index Surface_patch_index; //!< \cgalEmptyDoc
typedef typename Base::Subdomain_index Subdomain_index; //!< \cgalEmptyDoc
typedef typename Base::Corner_index Corner_index;
typedef typename Base::Curve_index Curve_index;
typedef typename Base::Surface_patch_index Surface_patch_index;
typedef typename Base::Subdomain_index Subdomain_index;
/// @}
/// @cond DEVELOPERS