diff --git a/Algebraic_foundations/include/CGAL/Algebraic_extension_traits.h b/Algebraic_foundations/include/CGAL/Algebraic_extension_traits.h index 32c74d7f355..aa27bdd2b38 100644 --- a/Algebraic_foundations/include/CGAL/Algebraic_extension_traits.h +++ b/Algebraic_foundations/include/CGAL/Algebraic_extension_traits.h @@ -14,7 +14,7 @@ /*! \file CGAL/Algebraic_extension_traits.h - * \brief Defines traits class CGAL::Algebraic_extension_traits. + * \brief defines traits class CGAL::Algebraic_extension_traits. */ #ifndef CGAL_ALGEBRAIC_NUMBER_TRAITS_H diff --git a/Algebraic_foundations/include/CGAL/Coercion_traits.h b/Algebraic_foundations/include/CGAL/Coercion_traits.h index b61d24af57e..85f5f0cf950 100644 --- a/Algebraic_foundations/include/CGAL/Coercion_traits.h +++ b/Algebraic_foundations/include/CGAL/Coercion_traits.h @@ -13,7 +13,7 @@ // ============================================================================= /*! \file NiX/Coercion_traits.h - * \brief Defines class NiX::Coercion_traits. + * \brief defines class NiX::Coercion_traits. * * Provides the general definition of the \c Coercion_traits class, with * specializations for the builtin number types. diff --git a/Algebraic_foundations/include/CGAL/Fraction_traits.h b/Algebraic_foundations/include/CGAL/Fraction_traits.h index 752db4d6554..3b456907dc2 100644 --- a/Algebraic_foundations/include/CGAL/Fraction_traits.h +++ b/Algebraic_foundations/include/CGAL/Fraction_traits.h @@ -17,7 +17,7 @@ // they may be wrong now. /*! \file NiX/Fraction_traits.h - \brief Defines class NiX::Fraction_traits. + \brief defines class NiX::Fraction_traits. Provides dependent types and function objects for all the functions beyond operators with specializations of the \c Fraction_traits diff --git a/Algebraic_foundations/include/CGAL/Needs_parens_as_product.h b/Algebraic_foundations/include/CGAL/Needs_parens_as_product.h index 53582b56604..a55040176d1 100644 --- a/Algebraic_foundations/include/CGAL/Needs_parens_as_product.h +++ b/Algebraic_foundations/include/CGAL/Needs_parens_as_product.h @@ -27,7 +27,7 @@ namespace CGAL { class Parens_as_product_tag {}; /*! \ingroup NiX_io_parens - * \brief Decides whether this number requires parentheses + * \brief decides whether this number requires parentheses * in case it appears within a produkt. */ template @@ -36,7 +36,7 @@ struct Needs_parens_as_product{ }; /*! \ingroup NiX_io_parens - * \brief Decides whether this number requires parentheses + * \brief decides whether this number requires parentheses * in case it appears within a produkt. */ template diff --git a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Algebraic_real_d_1.h b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Algebraic_real_d_1.h index eecc13aad01..11900ce8bfa 100644 --- a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Algebraic_real_d_1.h +++ b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Algebraic_real_d_1.h @@ -180,13 +180,13 @@ public: } } - /*! \brief Refines the isolating interval. */ + /*! \brief refines the isolating interval. */ void refine() const{ this->ptr()->refine(); } /*! \brief Bisects the isolating interval. */ void bisect() const{ this->ptr()->bisect(); } - /*! \brief Refines the isolating interval until \a m is outside + /*! \brief refines the isolating interval until \a m is outside * the \c closed interval */ template < class NTX > diff --git a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Bitstream_descartes.h b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Bitstream_descartes.h index 7f4d0f29ade..00b2dfcd689 100644 --- a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Bitstream_descartes.h +++ b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Bitstream_descartes.h @@ -375,7 +375,7 @@ public: } /*! - * \brief Gives an opportunity to process the nodes after + * \brief gives an opportunity to process the nodes after * the subdivision steps are finished * * This method must be specialised by derived classes, but can @@ -386,7 +386,7 @@ public: return; } - /*! \brief Returns whether the \c i th root is definitely a simple root + /*! \brief returns whether the \c i th root is definitely a simple root * of the isolated polynomial * * Must be specialised by derived class @@ -396,7 +396,7 @@ public: return false; } - /*! \brief Returns whether the \c i th root is definitely a multiple root + /*! \brief returns whether the \c i th root is definitely a multiple root * of the isolated polynomial * * Must be specialised by derived class @@ -1040,7 +1040,7 @@ public: } - /*! \brief Returns whether the \c i th root is definitely a simple root + /*! \brief returns whether the \c i th root is definitely a simple root * of the isolated polynomial * */ @@ -1048,7 +1048,7 @@ public: return false; } - /*! \brief Returns whether the \c i th root is definitely + /*! \brief returns whether the \c i th root is definitely * a multiple root * of the isolated polynomial * @@ -1372,7 +1372,7 @@ public: bool is_exact_root(int) const { return false; } /*! - * \brief Returns true if the ith root is known to be a simple + * \brief returns true if the ith root is known to be a simple * root of the curve. */ bool is_certainly_simple_root(int i) const { @@ -1381,7 +1381,7 @@ public: } /*! - * \brief Returns true if the ith root is known to be a multiple + * \brief returns true if the ith root is known to be a multiple * root of the curve. */ bool is_certainly_multiple_root(int i) const { @@ -1391,7 +1391,7 @@ public: /*! - * \brief Returns the multiplicity of the root if know, otherwise -1 + * \brief returns the multiplicity of the root if know, otherwise -1 */ int multiplicity_of_root(int i) const { CGAL_assertion(is_isolated()); @@ -1407,7 +1407,7 @@ public: } /*! - * \brief Returns the isolator of the polynomial f(1/x + q), if known + * \brief returns the isolator of the polynomial f(1/x + q), if known */ Self inverse_transform_isolator() const { return this->ptr()->inverse_transform_isolator(); diff --git a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Bitstream_descartes_E08_tree.h b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Bitstream_descartes_E08_tree.h index a4031073c04..d78d50acfd0 100644 --- a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Bitstream_descartes_E08_tree.h +++ b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Bitstream_descartes_E08_tree.h @@ -707,13 +707,13 @@ public: this->ptr()->node_list_.erase(n); } - /*! \brief Replace traits class + /*! \brief replaces traits class */ void set_traits(TRAITS& traits) { this->ptr()->b_from_p_.set_traits(traits); } - /*! \brief Returns a copy of this with its own representation + /*! \brief returns a copy of this with its own representation */ Self make_unique() const { Self tmp = *this; diff --git a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Bitstream_descartes_rndl_tree.h b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Bitstream_descartes_rndl_tree.h index eac9950abc6..869b758cb12 100644 --- a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Bitstream_descartes_rndl_tree.h +++ b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Bitstream_descartes_rndl_tree.h @@ -1079,7 +1079,7 @@ public: this->ptr()->node_list_.erase(n); } - /*! \brief Replace traits class + /*! \brief replaces traits class */ void set_traits(TRAITS& traits) { @@ -1090,7 +1090,7 @@ public: } - /*! \brief Returns a copy of this with its own representation + /*! \brief returns a copy of this with its own representation */ Self make_unique() const { Self tmp = *this; diff --git a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Curve_analysis_2.h b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Curve_analysis_2.h index a0747b89dd2..188610dac44 100644 --- a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Curve_analysis_2.h +++ b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Curve_analysis_2.h @@ -512,7 +512,7 @@ public: private: /* - * \brief Sets all status lines at events and of intervals + * \brief sets all status lines at events and of intervals * * Writes the status lines of events and interval into the object. * The value type of both \c InputIterator1 and \c InputIterator2 @@ -571,7 +571,7 @@ private: public: - /*! \brief Returns whether the curve has a valid defining polynomial + /*! \brief returns whether the curve has a valid defining polynomial */ bool has_defining_polynomial() const { return bool(this->ptr()->f); @@ -579,7 +579,7 @@ public: public: - /*! \brief Sets the defining polynomial. + /*! \brief sets the defining polynomial. * * \pre The object has no defining polynomial yet. */ @@ -595,7 +595,7 @@ public: public: /*! - * \brief Returns whether the curve is y-regular + * \brief returns whether the curve is y-regular * * A curve is called y-regular if the leading coefficient of its defining * polynomial wrt y is a constant, i.e., contains no x @@ -646,7 +646,7 @@ public: public: /*! - * \brief Returns the number of event lines of the curve + * \brief returns the number of event lines of the curve * * Algebraically, the number of real roots of the discriminant of * the curve's defining equation is returned. @@ -664,7 +664,7 @@ public: public: /*! - * \brief Returns whether the given x-coordinate is critical for the curve + * \brief returns whether the given x-coordinate is critical for the curve * and which event or interval index the x-coordinate belongs to. * * \param is_event is set to \c true if the curve has an event @@ -734,7 +734,7 @@ public: private: /* - * \brief Returns a status line for an exact value \c alpha that + * \brief returns a status line for an exact value \c alpha that * is not an event of the curve * * This function controls the internal cache that stores already created @@ -1167,7 +1167,7 @@ private: public: /*! - * \brief Returns the status line for the interval + * \brief returns the status line for the interval * preceeding the ith event * * Returns a status line for a reference x-coordinate of the ith @@ -1235,7 +1235,7 @@ public: private: /* - * \brief Creates an intermediate line at position \c ar. + * \brief creates an intermediate line at position \c ar. * * It is required that none of the following situations occurs at position * ar: singularity, vertical tangent line, vertical asymptote.\n @@ -1279,7 +1279,7 @@ private: private: /* - * \brief Returns an Event_line_builder instance + * \brief returns an Event_line_builder instance * * Note: So far, a new instance is created each time the function is called */ @@ -1444,7 +1444,7 @@ private: public: /*! - * \brief Returns the ith Sturm-Habicht polynomial + * \brief returns the ith Sturm-Habicht polynomial * of the primitive part of the defining polynomial */ Polynomial_2 sturm_habicht_of_primitive(size_type i) const @@ -1458,7 +1458,7 @@ public: public: /*! - * \brief Returns the ith principal Sturm-Habicht coefficient + * \brief returns the ith principal Sturm-Habicht coefficient * of the primitive part of the defining polynomial */ Polynomial_1 principal_sturm_habicht_of_primitive(size_type i) const @@ -1477,7 +1477,7 @@ public: public: /*! - * \brief Returns the ith coprincipal Sturm-Habicht coefficient + * \brief returns the ith coprincipal Sturm-Habicht coefficient * of the primitive part of the defining polynomial * * The coprincipal Sturm-Habicht coefficient is the coefficient @@ -1498,7 +1498,7 @@ public: public: /*! - * \brief Returns an iterator to the principal Sturm-Habicht coefficients, + * \brief returns an iterator to the principal Sturm-Habicht coefficients, * starting with the 0th one (the resultant) */ Principal_sturm_habicht_iterator principal_sturm_habicht_begin() const { @@ -1930,7 +1930,7 @@ private: public: /*! - * \brief Returns a \c Curve_analysis_2 object for a sheared curve. + * \brief returns a \c Curve_analysis_2 object for a sheared curve. * * The shear factor is given by the integer \c s. * This functions only shears the primitive part of the defining equation. @@ -2082,7 +2082,7 @@ public: public: /*! - * \brief Returns the limit an infinite arc converges to + * \brief returns the limit an infinite arc converges to * * \pre loc==CGAL::LEFT_BOUNDARY || * loc==CGAL::RIGHT_BOUNDARY @@ -2399,7 +2399,7 @@ private: }; // class Algebraic_curve_2_2 -//! \brief Prints the objects. +//! \brief prints the objects. template std::ostream& operator<< ( @@ -2507,7 +2507,7 @@ std::ostream& operator<< ( return out; } -//! \brief Reads the objects from stream +//! \brief reads the objects from stream template std::istream& operator>> ( diff --git a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Curve_pair_analysis_2.h b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Curve_pair_analysis_2.h index b20f8d7ea7f..05b97af9bcd 100644 --- a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Curve_pair_analysis_2.h +++ b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Curve_pair_analysis_2.h @@ -611,7 +611,7 @@ public: public: /* - * \brief Returns the indices of the ith event value + * \brief returns the indices of the ith event value * * Returns a Event_indices (fg,ffy,ggy) such that * the ith event root is the fgth root of the @@ -963,7 +963,7 @@ public: } /*! - * \brief Returns the number of event slices + * \brief returns the number of event slices * * Precisely, this is the number of points which are either root of * the resultant of the two curves, or root of discriminant of one @@ -1171,7 +1171,7 @@ private: Integer s) const; /* - * \brief Reduces the number of possible intersections + * \brief reduces the number of possible intersections * * At the position given by the event lins \c e1 and \c e2 and the slice * info object \c slice, the points on the event lines are further refined @@ -1197,7 +1197,7 @@ private: }; // end of Curve_pair_analysis_2 -//! \brief Prints the objects. +//! \brief prints the objects. template std::ostream& operator<< (std::ostream& out, diff --git a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Descartes.h b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Descartes.h index 705aa022d83..9c4264a2c29 100644 --- a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Descartes.h +++ b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Descartes.h @@ -16,7 +16,7 @@ // they may be wrong now. /*! \file NiX/Descartes.h - \brief Defines class NiX::Descartes. + \brief defines class NiX::Descartes. Isolate real roots of polynomials. diff --git a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Event_line_builder.h b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Event_line_builder.h index 67188cecd74..75ca4b777f1 100644 --- a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Event_line_builder.h +++ b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/Event_line_builder.h @@ -114,7 +114,7 @@ public: /*! - * \brief Creates an event line at position \c alpha for the specified + * \brief creates an event line at position \c alpha for the specified * curve. * * Additionally, the \c id of the event line to be created has to be diff --git a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/algebraic_curve_kernel_2_tools.h b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/algebraic_curve_kernel_2_tools.h index 58a80d975a1..b1fa29353b4 100644 --- a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/algebraic_curve_kernel_2_tools.h +++ b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/algebraic_curve_kernel_2_tools.h @@ -95,7 +95,7 @@ set_union_with_source(InputIterator1 first_begin, } /* - * \brief Removes the leading term of the polynomial \c f as long as it + * \brief removes the leading term of the polynomial \c f as long as it * vanishes at \c alpha * */ @@ -169,7 +169,7 @@ template typename AlgebraicKernel_1::Bound /*! - * \brief Produces intermediate rational values for a list of + * \brief produces intermediate rational values for a list of * algebraic reals. * * For a list of Algebraic real values with \c n elements, a list with diff --git a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/bound_between_1.h b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/bound_between_1.h index 67dd1a3ea3f..ade0be4a1a5 100644 --- a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/bound_between_1.h +++ b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/bound_between_1.h @@ -36,7 +36,7 @@ namespace CGAL { namespace internal { -/*! \brief Tries to find a SIMPLE rational q with aq * is a power of two, and is not too big. There is no guarantee to find diff --git a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/enums.h b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/enums.h index 69224240637..3e28631f607 100644 --- a/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/enums.h +++ b/Algebraic_kernel_d/include/CGAL/Algebraic_kernel_d/enums.h @@ -31,7 +31,7 @@ namespace internal { } // namespace internal /*! - * \brief Represents different strategies how to handle + * \brief represents different strategies how to handle * degenerate cases during the analysis * * Currently, there are two possible strategies implemented. See the diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_topology_traits/Arr_spherical_topology_traits_2_impl.h b/Arrangement_on_surface_2/include/CGAL/Arr_topology_traits/Arr_spherical_topology_traits_2_impl.h index 8a2b4d4d4ba..08b6c653034 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_topology_traits/Arr_spherical_topology_traits_2_impl.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_topology_traits/Arr_spherical_topology_traits_2_impl.h @@ -423,7 +423,7 @@ compare_y_at_x(const Point_2& p, const Halfedge* he) const return m_geom_traits->compare_y_at_x_2_object()(p, he->curve()); } -/*! \brief determine whether a vertex is associated with a curve end */ +/*! \brief determines whether a vertex is associated with a curve end */ template bool Arr_spherical_topology_traits_2:: are_equal(const Vertex* v, @@ -803,7 +803,7 @@ _locate_around_pole(Vertex* v, return nullptr; } -/*! \brief Return the face that lies below the given vertex, which lies +/*! \brief returns the face that lies below the given vertex, which lies * on the line of discontinuity. */ template diff --git a/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/Arc_2.h b/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/Arc_2.h index f0fdab150de..0e963f93c88 100644 --- a/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/Arc_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/Arc_2.h @@ -14,7 +14,7 @@ #define CGAL_CURVED_KERNEL_VIA_ANALYSIS_2_ARC_2_H /*!\file include/CGAL/Curved_kernel_via_analysis_2/Arc_2.h - *\brief Defines class \c Arc_2 that represents an arc on a curve that + *\brief defines class \c Arc_2 that represents an arc on a curve that * can be analyzed. */ @@ -3360,7 +3360,7 @@ std::ostream& operator<<( } -//! \brief Reads the objects from stream. +//! \brief reads the objects from stream. template < class CurvedKernelViaAnalysis_2, class Rep_ > std::istream& operator>> ( std::istream& is, diff --git a/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/Make_x_monotone_2.h b/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/Make_x_monotone_2.h index 495137bfee9..e0a51c6565a 100644 --- a/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/Make_x_monotone_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/Make_x_monotone_2.h @@ -18,7 +18,7 @@ #define CGAL_CURVED_KERNEL_VIA_ANALYSIS_2_MAKE_X_MONOTONE_2_H /*!\file include/CGAL/Curved_kernel_via_analysis_2/Make_x_monotone_2.h - * \brief Defines \c Make_x_monotone_2 functor + * \brief defines \c Make_x_monotone_2 functor */ #include diff --git a/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/Point_2.h b/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/Point_2.h index 8a26fb9ee55..ad526dfa23d 100644 --- a/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/Point_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/Point_2.h @@ -15,7 +15,7 @@ #define CGAL_CURVED_KERNEL_VIA_ANALYSIS_2_POINT_2_H /*!\file include/CGAL/Curved_kernel_via_analysis_2/Point_2.h - * \brief Defines class \c Point_2 that represents a point on a curve that can + * \brief defines class \c Point_2 that represents a point on a curve that can * be analyzed. */ @@ -817,7 +817,7 @@ std::ostream& operator <<(std::ostream& os, } -//! \brief Reads the objects from stream. +//! \brief reads the objects from stream. template < class CurvedKernelViaAnalysis_2, class Rep_ > std::istream& operator>> ( std::istream& is, diff --git a/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/gfx/Subdivision_2.h b/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/gfx/Subdivision_2.h index e419876590e..1e5841429ee 100644 --- a/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/gfx/Subdivision_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Curved_kernel_via_analysis_2/gfx/Subdivision_2.h @@ -195,7 +195,7 @@ private: //! for univariate case void get_range_AARD_1(int var, const NT& lower, const NT& upper, const Poly_1& poly, NT& l, NT& h); - //! \brief Recursive Taylor, bivariate case + //! \brief recursive Taylor, bivariate case //! //! returns a range of polynomial values as Affine_form void get_range_RT_2(const NT& x_low, const NT& x_high, const NT& y_low, @@ -283,7 +283,7 @@ void Subdivision_2::subdivide(const NT& x_low, quad_tree(x_mid,x_high,y_low,y_mid); } -//! \brief Recursive Taylor, bivariate case +//! \brief recursive Taylor, bivariate case template void Subdivision_2::get_range_RT_2( const NT& x_low, const NT& x_high, const NT& y_low, const NT& y_high, diff --git a/BGL/include/CGAL/boost/graph/IO/3MF.h b/BGL/include/CGAL/boost/graph/IO/3MF.h index fd148edee3e..acbd1180b93 100644 --- a/BGL/include/CGAL/boost/graph/IO/3MF.h +++ b/BGL/include/CGAL/boost/graph/IO/3MF.h @@ -33,7 +33,7 @@ namespace CGAL { /*! * \ingroup PkgBGLIOFuncs3MF * - * \brief Writes the triangle meshes contained in `gs` into the 3mf file `filename`. + * \brief writes the triangle meshes contained in `gs` into the 3mf file `filename`. * * \tparam GraphRange a model of the concepts `RandomAccessContainer` * and `BackInsertionSequence` whose `value type` is diff --git a/BGL/include/CGAL/boost/graph/IO/GOCAD.h b/BGL/include/CGAL/boost/graph/IO/GOCAD.h index aecee5cf172..09bc85bd9c4 100644 --- a/BGL/include/CGAL/boost/graph/IO/GOCAD.h +++ b/BGL/include/CGAL/boost/graph/IO/GOCAD.h @@ -82,7 +82,7 @@ public: /// \ingroup PkgBGLIoFuncsGOCAD /// -/// \brief Reads the graph `g` from the input stream, using the \ref IOStreamGocad. +/// \brief reads the graph `g` from the input stream, using the \ref IOStreamGocad. /// /// \attention The graph `g` is not cleared, and the data from the stream is added. /// @@ -146,7 +146,7 @@ bool read_GOCAD(std::istream& is, std::pair& name_and_ /// \ingroup PkgBGLIoFuncsGOCAD /// -/// \brief Reads the graph `g` from the file `fname`, using the \ref IOStreamGocad. +/// \brief reads the graph `g` from the file `fname`, using the \ref IOStreamGocad. /// /// \attention The graph `g` is not cleared, and the data from the stream is added. /// @@ -212,7 +212,7 @@ bool read_GOCAD(const std::string& fname, Graph& g) { return read_GOCAD(fname, g /// \ingroup PkgBGLIoFuncsGOCAD /// -/// \brief Writes the graph `g` into the output stream `os`, using the \ref IOStreamGocad. +/// \brief writes the graph `g` into the output stream `os`, using the \ref IOStreamGocad. /// /// \tparam Graph a model of `FaceListGraph` /// \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -309,7 +309,7 @@ bool write_GOCAD(std::ostream& os, const char* name, const Graph& g) /// \ingroup PkgBGLIoFuncsGOCAD /// -/// \brief Writes the graph `g` into a file named `fname`, using the \ref IOStreamGocad. +/// \brief writes the graph `g` into a file named `fname`, using the \ref IOStreamGocad. /// /// In this overload, `fname` is used as the name of the graph within the file. /// @@ -357,7 +357,7 @@ bool write_GOCAD(const std::string& fname, const Graph& g, const CGAL_BGL_NP_CLA /// \ingroup PkgBGLIoFuncsGOCAD /// -/// \brief Writes the graph `g` in the \ref IOStreamGocad into `os`. +/// \brief writes the graph `g` in the \ref IOStreamGocad into `os`. /// /// The name assigned to `g`in the output is `anonymous`. /// diff --git a/BGL/include/CGAL/boost/graph/IO/OBJ.h b/BGL/include/CGAL/boost/graph/IO/OBJ.h index 1bbc7c27c56..a0646387089 100644 --- a/BGL/include/CGAL/boost/graph/IO/OBJ.h +++ b/BGL/include/CGAL/boost/graph/IO/OBJ.h @@ -74,7 +74,7 @@ public: /*! \ingroup PkgBGLIoFuncsOBJ - \brief Reads the graph `g` from the stream `in`, using the \ref IOStreamOBJ. + \brief reads the graph `g` from the stream `in`, using the \ref IOStreamOBJ. Ignores comment lines which start with a hash, and lines with whitespace. @@ -122,7 +122,7 @@ bool read_OBJ(std::istream& is, /*! \ingroup PkgBGLIoFuncsOBJ - \brief Reads the graph `g` from the file `fname`, using the \ref IOStreamOBJ. + \brief reads the graph `g` from the file `fname`, using the \ref IOStreamOBJ. Ignores comment lines which start with a hash, and lines with whitespace. @@ -187,7 +187,7 @@ bool read_OBJ(const std::string& fname, Graph& g) { return read_OBJ(fname, g, pa /*! \ingroup PkgBGLIoFuncsOBJ - \brief Writes the graph `g` into the output stream, using the \ref IOStreamOBJ. + \brief writes the graph `g` into the output stream, using the \ref IOStreamOBJ. \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -230,7 +230,7 @@ bool write_OBJ(std::ostream& os, /*! \ingroup PkgBGLIoFuncsOBJ - \brief Writes the graph `g` into a file named `fname`, using the \ref IOStreamOBJ. + \brief writes the graph `g` into a file named `fname`, using the \ref IOStreamOBJ. \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" diff --git a/BGL/include/CGAL/boost/graph/IO/OFF.h b/BGL/include/CGAL/boost/graph/IO/OFF.h index 0a7483ccb4b..63b116a644e 100644 --- a/BGL/include/CGAL/boost/graph/IO/OFF.h +++ b/BGL/include/CGAL/boost/graph/IO/OFF.h @@ -88,7 +88,7 @@ bool read_OFF_BGL(std::istream& is, /*! \ingroup PkgBGLIoFuncsOFF - \brief Reads the graph `g` from data in the input stream, using the \ref IOStreamOFF. + \brief reads the graph `g` from data in the input stream, using the \ref IOStreamOFF. Ignores comment lines which start with a hash, and lines with whitespace. @@ -171,7 +171,7 @@ bool read_OFF(std::istream& is, Graph& g, /*! \ingroup PkgBGLIoFuncsOFF - \brief Reads the graph `g` from the file `fname`, using the \ref IOStreamOFF. + \brief reads the graph `g` from the file `fname`, using the \ref IOStreamOFF. Ignores comment lines which start with a hash, and lines with whitespace. @@ -314,7 +314,7 @@ bool write_OFF_BGL(std::ostream& os, /*! \ingroup PkgBGLIoFuncsOFF - \brief Writes the graph `g` in the output stream, using the \ref IOStreamOFF. + \brief writes the graph `g` in the output stream, using the \ref IOStreamOFF. \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -395,7 +395,7 @@ bool write_OFF(std::ostream& os, const Graph& g, /*! \ingroup PkgBGLIoFuncsOFF - \brief Writes the graph `g` in the file `fname`, using the \ref IOStreamOFF. + \brief writes the graph `g` in the file `fname`, using the \ref IOStreamOFF. \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" diff --git a/BGL/include/CGAL/boost/graph/IO/PLY.h b/BGL/include/CGAL/boost/graph/IO/PLY.h index 82244b69a54..05a73ef4938 100644 --- a/BGL/include/CGAL/boost/graph/IO/PLY.h +++ b/BGL/include/CGAL/boost/graph/IO/PLY.h @@ -83,7 +83,7 @@ bool read_PLY_BGL(std::istream& is, /*! \ingroup PkgBGLIoFuncsPLY - \brief Reads the graph `g` from the input stream, using the \ref IOStreamPLY. + \brief reads the graph `g` from the input stream, using the \ref IOStreamPLY. \tparam Graph a model of `MutableFaceGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -155,7 +155,7 @@ bool read_PLY(std::istream& is, Graph& g, /*! \ingroup PkgBGLIoFuncsPLY - \brief Reads the graph `g` from a file named `fname`, using the \ref IOStreamPLY. + \brief reads the graph `g` from a file named `fname`, using the \ref IOStreamPLY. \tparam Graph a model of `MutableFaceGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -261,7 +261,7 @@ bool read_PLY(const std::string& fname, Graph& g, /*! \ingroup PkgBGLIoFuncsPLY - \brief Writes the graph in an output stream, using the \ref IOStreamPLY. + \brief writes the graph in an output stream, using the \ref IOStreamPLY. \tparam Graph a model of `FaceListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -461,7 +461,7 @@ bool write_PLY(std::ostream& os, const Graph& g, /*! \ingroup PkgBGLIoFuncsPLY - \brief Writes the graph in the output file `fname`, using the \ref IOStreamPLY. + \brief writes the graph in the output file `fname`, using the \ref IOStreamPLY. \tparam Graph a model of `FaceListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" diff --git a/BGL/include/CGAL/boost/graph/IO/STL.h b/BGL/include/CGAL/boost/graph/IO/STL.h index 4ca2ad67ade..f1f6d45324d 100644 --- a/BGL/include/CGAL/boost/graph/IO/STL.h +++ b/BGL/include/CGAL/boost/graph/IO/STL.h @@ -69,7 +69,7 @@ public: /*! \ingroup PkgBGLIoFuncsSTL - \brief Reads the graph `g` from the input stream, using the \ref IOStreamSTL. + \brief reads the graph `g` from the input stream, using the \ref IOStreamSTL. \attention The graph `g` is not cleared, and the data from the stream is added. @@ -114,7 +114,7 @@ bool read_STL(std::istream& is, /*! \ingroup PkgBGLIoFuncsSTL - \brief Reads the graph `g` from the file `fname`, using the \ref IOStreamSTL. + \brief reads the graph `g` from the file `fname`, using the \ref IOStreamSTL. \attention The graph `g` is not cleared, and the data from the stream is added. @@ -172,7 +172,7 @@ bool read_STL(const std::string& fname, Graph& g) { return read_STL(fname, g, pa /*! \ingroup PkgBGLIoFuncsSTL - \brief Writes the graph `g` in the output stream `os`, using the \ref IOStreamSTL. + \brief writes the graph `g` in the output stream `os`, using the \ref IOStreamSTL. \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -280,7 +280,7 @@ bool write_STL(std::ostream& os, /*! \ingroup PkgBGLIoFuncsSTL - \brief Writes the graph `g` into a file named `fname`, using the \ref IOStreamSTL. + \brief writes the graph `g` into a file named `fname`, using the \ref IOStreamSTL. \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" diff --git a/BGL/include/CGAL/boost/graph/IO/VTK.h b/BGL/include/CGAL/boost/graph/IO/VTK.h index ed963ebbfa5..eb84d9b0993 100644 --- a/BGL/include/CGAL/boost/graph/IO/VTK.h +++ b/BGL/include/CGAL/boost/graph/IO/VTK.h @@ -113,7 +113,7 @@ bool vtkPointSet_to_polygon_mesh(vtkPointSet* poly_data, /*! * \ingroup PkgBGLIoFuncsVTP * - * \brief Reads a PolyData in the \ref IOStreamVTK into a triangulated surface mesh. + * \brief reads a PolyData in the \ref IOStreamVTK into a triangulated surface mesh. * * \tparam Graph a model of `MutableFaceGraph` * \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -383,7 +383,7 @@ void write_polys_points(std::ostream& os, /*! \ingroup PkgBGLIoFuncsVTP * - * \brief Writes a triangulated surface mesh in the `PolyData` XML format (\ref IOStreamVTK). + * \brief writes a triangulated surface mesh in the `PolyData` XML format (\ref IOStreamVTK). * * \tparam Graph a model of `FaceListGraph` * \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -480,7 +480,7 @@ bool write_VTP(std::ostream& os, /*! \ingroup PkgBGLIoFuncsVTP * - * \brief Writes a triangulated surface mesh the file `fname`, in the `PolyData` XML format (\ref IOStreamVTK). + * \brief writes a triangulated surface mesh the file `fname`, in the `PolyData` XML format (\ref IOStreamVTK). * * \tparam Graph a model of `FaceListGraph` * \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" diff --git a/BGL/include/CGAL/boost/graph/IO/WRL.h b/BGL/include/CGAL/boost/graph/IO/WRL.h index 8c4d3a418ce..3780ad599bb 100644 --- a/BGL/include/CGAL/boost/graph/IO/WRL.h +++ b/BGL/include/CGAL/boost/graph/IO/WRL.h @@ -31,7 +31,7 @@ namespace CGAL { /*! \ingroup PkgBGLIoFuncsWRL - \brief Writes the graph `g` into the output stream, using the \ref IOStreamWRL (VRML 2.0). + \brief writes the graph `g` into the output stream, using the \ref IOStreamWRL (VRML 2.0). \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -71,7 +71,7 @@ bool write_WRL(std::ostream& os, /*! \ingroup PkgBGLIoFuncsWRL - \brief Writes the graph `g` into the output file, using the \ref IOStreamWRL (VRML 2.0). + \brief writes the graph `g` into the output file, using the \ref IOStreamWRL (VRML 2.0). \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" diff --git a/BGL/include/CGAL/boost/graph/generators.h b/BGL/include/CGAL/boost/graph/generators.h index 389f9ba3308..d5425047bc3 100644 --- a/BGL/include/CGAL/boost/graph/generators.h +++ b/BGL/include/CGAL/boost/graph/generators.h @@ -124,7 +124,7 @@ random_face_in_mesh(const Graph& g, CGAL::Random& rnd = get_default_random()) /** * \ingroup PkgBGLHelperFct * - * \brief Creates an isolated triangle + * \brief creates an isolated triangle * with its vertices initialized to `p0`, `p1` and `p2`, and adds it to the graph `g`. * * \returns the non-border halfedge that has the target vertex associated with `p0`. @@ -249,7 +249,7 @@ struct Default_grid_maker /** * \ingroup PkgBGLHelperFct * - * \brief Creates an isolated quad with + * \brief creates an isolated quad with * its vertices initialized to `p0`, `p1`, `p2`, and `p3`, and adds it to the graph `g`. * * \returns the non-border halfedge that has the target vertex associated with `p0`. @@ -279,7 +279,7 @@ make_quad(const P& p0, const P& p1, const P& p2, const P& p3, Graph& g) /** * \ingroup PkgBGLHelperFct - * \brief Creates an isolated hexahedron + * \brief creates an isolated hexahedron * with its vertices initialized to `p0`, `p1`, ...\ , and `p7`, and adds it to the graph `g`. * \image html hexahedron.png * \image latex hexahedron.png @@ -341,7 +341,7 @@ make_hexahedron(const P& p0, const P& p1, const P& p2, const P& p3, /** * \ingroup PkgBGLHelperFct - * \brief Creates an isolated tetrahedron + * \brief creates an isolated tetrahedron * with its vertices initialized to `p0`, `p1`, `p2`, and `p3`, and adds it to the graph `g`. * \image html tetrahedron.png * \image latex tetrahedron.png @@ -440,7 +440,7 @@ make_tetrahedron(const P& p0, const P& p1, const P& p2, const P& p3, Graph& g) /** * \ingroup PkgBGLHelperFct * - * \brief Creates a triangulated regular prism, outward oriented, + * \brief creates a triangulated regular prism, outward oriented, * having `nb_vertices` vertices in each of its bases and adds it to the graph `g`. * If `center` is (0, 0, 0), then the first point of the prism is (`radius`, `height`, 0) * @@ -539,7 +539,7 @@ make_regular_prism(typename boost::graph_traits::vertices_size_type nb_ve /** * \ingroup PkgBGLHelperFct - * \brief Creates a pyramid, outward oriented, having `nb_vertices` vertices in its base and adds it to the graph `g`. + * \brief creates a pyramid, outward oriented, having `nb_vertices` vertices in its base and adds it to the graph `g`. * * If `center` is `(0, 0, 0)`, then the first point of the base is `(radius, 0, 0)` * @@ -628,7 +628,7 @@ make_pyramid(typename boost::graph_traits::vertices_size_type nb_vertices /** * \ingroup PkgBGLHelperFct * - * \brief Creates an icosahedron, outward oriented, centered in `center` and adds it to the graph `g`. + * \brief creates an icosahedron, outward oriented, centered in `center` and adds it to the graph `g`. * * \param g the graph in which the icosahedron will be created. * \param center the center of the sphere in which the icosahedron is inscribed. @@ -721,7 +721,7 @@ make_icosahedron(Graph& g, /*! * \ingroup PkgBGLHelperFct * - * \brief Creates a row major ordered grid with `i` cells along the width and `j` cells + * \brief creates a row major ordered grid with `i` cells along the width and `j` cells * along the height and adds it to the graph `g`. * An internal property map for `CGAL::vertex_point_t` must be available in `Graph`. * diff --git a/Classification/doc/Classification/Concepts/NeighborQuery.h b/Classification/doc/Classification/Concepts/NeighborQuery.h index 0c768d4862b..eeed7fa074c 100644 --- a/Classification/doc/Classification/Concepts/NeighborQuery.h +++ b/Classification/doc/Classification/Concepts/NeighborQuery.h @@ -27,7 +27,7 @@ public: /*! - \brief Puts in `output` the indices of the neighbors of `query`. + \brief puts in `output` the indices of the neighbors of `query`. \tparam OutputIterator An output iterator accepting `std::size_t` values. diff --git a/Classification/include/CGAL/Classification/Cluster.h b/Classification/include/CGAL/Classification/Cluster.h index 4b8b002c3b5..40012e46bb0 100644 --- a/Classification/include/CGAL/Classification/Cluster.h +++ b/Classification/include/CGAL/Classification/Cluster.h @@ -122,7 +122,7 @@ public: void clear () { m_inliers->clear(); } /*! - \brief Inserts element of index `idx` in the cluster. + \brief inserts element of index `idx` in the cluster. */ void insert (std::size_t idx) { m_inliers->push_back (idx); } @@ -132,23 +132,23 @@ public: /// @{ /*! - \brief Returns the number of items in the cluster. + \brief returns the number of items in the cluster. */ std::size_t size() const { return m_inliers->size(); } /*! - \brief Returns the index (in the input range) of the i^{th} element of the cluster. + \brief returns the index (in the input range) of the i^{th} element of the cluster. */ std::size_t index (std::size_t i) const { return (*m_inliers)[i]; } /*! - \brief Returns the i^{th} item of the cluster. + \brief returns the i^{th} item of the cluster. */ const Item& operator[] (std::size_t i) const { return get (m_item_map, *(m_range->begin() + (*m_inliers)[i])); } /*! - \brief Returns the bounding box of the cluster. + \brief returns the bounding box of the cluster. */ const CGAL::Bbox_3& bbox() const { @@ -168,22 +168,22 @@ public: /// @{ /*! - \brief Returns the input classification value used for training. + \brief returns the input classification value used for training. */ int training() const { return m_training; } /*! - \brief Returns a reference to the input classification value used for training. + \brief returns a reference to the input classification value used for training. */ int& training() { return m_training; } /*! - \brief Returns the output classification value. + \brief returns the output classification value. */ int label() const { return m_label; } /*! - \brief Returns a reference to the output classification value. + \brief returns a reference to the output classification value. */ int& label() { return m_label; } diff --git a/Classification/include/CGAL/Classification/ETHZ/Random_forest_classifier.h b/Classification/include/CGAL/Classification/ETHZ/Random_forest_classifier.h index e2f831b5aca..87559d5e7b3 100644 --- a/Classification/include/CGAL/Classification/ETHZ/Random_forest_classifier.h +++ b/Classification/include/CGAL/Classification/ETHZ/Random_forest_classifier.h @@ -81,7 +81,7 @@ public: /// @{ /*! - \brief Instantiates the classifier using the sets of `labels` and `features`. + \brief instantiates the classifier using the sets of `labels` and `features`. */ Random_forest_classifier (const Label_set& labels, @@ -138,7 +138,7 @@ public: /// \endcond /*! - \brief Runs the training algorithm. + \brief runs the training algorithm. From the set of provided ground truth, this algorithm estimates sets up the random trees that produce the most accurate result @@ -280,7 +280,7 @@ public: /// @{ /*! - \brief Saves the current configuration in the stream `output`. + \brief saves the current configuration in the stream `output`. This allows to easily save and recover a specific classification configuration. @@ -302,7 +302,7 @@ public: #endif /*! - \brief Loads a configuration from the stream `input`. + \brief loads a configuration from the stream `input`. The input file should be a GZIP container written by the `save_configuration()` method. The feature set of the classifier diff --git a/Classification/include/CGAL/Classification/ETHZ/internal/dataview.h b/Classification/include/CGAL/Classification/ETHZ/internal/dataview.h index a067764c6d5..c67913e2f22 100644 --- a/Classification/include/CGAL/Classification/ETHZ/internal/dataview.h +++ b/Classification/include/CGAL/Classification/ETHZ/internal/dataview.h @@ -79,17 +79,17 @@ struct DataView2D { { return *(data + row_step * row_idx + col_step * col_idx); } - //! \brief Return a 1D view of a row + //! \brief returns a 1D view of a row DataView1D row(size_t row_idx) { return DataView1D(data + row_step * row_idx, cols, col_step); } - //! \brief Return a 1D view of a column + //! \brief returns a 1D view of a column DataView1D col(size_t col_idx) { return DataView1D(data + col_step * col_idx, rows, row_step); } - //! \brief Return a new view, using a subset of rows + //! \brief returns a new view, using a subset of rows DataView2D row_range(size_t start_row, size_t end_row) const { DataView2D ret(*this); @@ -97,7 +97,7 @@ struct DataView2D { ret.rows = end_row - start_row; return ret; } - //! \brief Return a new view, using a subset of columns + //! \brief returns a new view, using a subset of columns DataView2D col_range(size_t start_col, size_t end_col) const { DataView2D ret(*this); @@ -105,7 +105,7 @@ struct DataView2D { ret.cols = end_col - start_col; return ret; } - //! \brief Transpose the matrix (actually done by swapping the steps, no + //! \brief transposes the matrix (actually done by swapping the steps, no // copying) DataView2D transpose() const { @@ -124,23 +124,23 @@ struct DataView2D { { return DataView2D(vec.data, 1, vec.num_elements); } - //! \brief Return the number of elements in this view + //! \brief returns the number of elements in this view size_t num_elements() { return rows * cols; } - //! \brief Return true if the view is empty (no elements) + //! \brief returns true if the view is empty (no elements) bool empty() { return num_elements() == 0; } - //! \brief Return true if rows in this view are continuous in memory + //! \brief returns true if rows in this view are continuous in memory bool row_continuous() { return col_step == 1; } - //! \brief Return true if columns in this view are continuous in memory + //! \brief returns true if columns in this view are continuous in memory bool col_continuous() { return row_step == 1; } - //! \brief Get pointer to row (only valid if row-continuous) + //! \brief gets pointer to row (only valid if row-continuous) ElementType* row_pointer(size_t row_idx) { return data + row_idx * row_step; } - //! \brief Get pointer to column (only valid if column-continuous) + //! \brief gets pointer to column (only valid if column-continuous) ElementType* col_pointer(size_t col_idx) { return data + col_idx * col_step; } @@ -152,7 +152,7 @@ struct DataView2D { size_t cols; //!< Number of columns in the view }; -//! \brief Determine if two 2D views have the same dimensions +//! \brief determines if two 2D views have the same dimensions template bool equal_dims(DataView2D view_a, DataView2D view_b) { diff --git a/Classification/include/CGAL/Classification/Evaluation.h b/Classification/include/CGAL/Classification/Evaluation.h index 071f6ab8c9f..53deee88bc6 100644 --- a/Classification/include/CGAL/Classification/Evaluation.h +++ b/Classification/include/CGAL/Classification/Evaluation.h @@ -52,7 +52,7 @@ public: /*! - \brief Instantiates an evaluation object and computes all + \brief instantiates an evaluation object and computes all measurements. \param labels labels used. @@ -137,7 +137,7 @@ public: /*! - \brief Returns the precision of the training for the given label. + \brief returns the precision of the training for the given label. Precision is the number of true positives divided by the sum of the true positives and the false positives. @@ -150,7 +150,7 @@ public: /*! - \brief Returns the recall of the training for the given label. + \brief returns the recall of the training for the given label. Recall is the number of true positives divided by the sum of the true positives and the false negatives. @@ -163,7 +163,7 @@ public: /*! - \brief Returns the \f$F_1\f$ score of the training for the given label. + \brief returns the \f$F_1\f$ score of the training for the given label. \f$F_1\f$ score is the harmonic mean of `precision()` and `recall()`: @@ -180,7 +180,7 @@ public: } /*! - \brief Returns the intersection over union of the training for the + \brief returns the intersection over union of the training for the given label. Intersection over union is the number of true positives divided by @@ -199,7 +199,7 @@ public: /*! - \brief Returns the accuracy of the training. + \brief returns the accuracy of the training. Accuracy is the total number of true positives divided by the total number of provided inliers. @@ -207,13 +207,13 @@ public: float accuracy() const { return m_accuracy; } /*! - \brief Returns the mean \f$F_1\f$ score of the training over all + \brief returns the mean \f$F_1\f$ score of the training over all labels (see `f1_score()`). */ float mean_f1_score() const { return m_mean_f1; } /*! - \brief Returns the mean intersection over union of the training + \brief returns the mean intersection over union of the training over all labels (see `intersection_over_union()`). */ float mean_intersection_over_union() const { return m_mean_iou; } diff --git a/Classification/include/CGAL/Classification/Feature_base.h b/Classification/include/CGAL/Classification/Feature_base.h index 469bf079bc9..bd317484b23 100644 --- a/Classification/include/CGAL/Classification/Feature_base.h +++ b/Classification/include/CGAL/Classification/Feature_base.h @@ -42,18 +42,18 @@ public: /// \endcond /*! - \brief Returns the name of the feature (initialized to + \brief returns the name of the feature (initialized to `abstract_feature` for `Feature_base`). */ const std::string& name() const { return m_name; } /*! - \brief Changes the name of the feature. + \brief changes the name of the feature. */ void set_name (const std::string& name) { m_name = name; } /*! - \brief Returns the value taken by the feature for at the item for + \brief returns the value taken by the feature for at the item for the item at position `index`. This method must be implemented by inherited classes. */ diff --git a/Classification/include/CGAL/Classification/Feature_set.h b/Classification/include/CGAL/Classification/Feature_set.h index 13fb59840e5..f4a4eeeafbd 100644 --- a/Classification/include/CGAL/Classification/Feature_set.h +++ b/Classification/include/CGAL/Classification/Feature_set.h @@ -33,7 +33,7 @@ namespace Classification { /*! \ingroup PkgClassificationFeature -\brief Set of features (see `Feature_base`) used as input by +\brief sets of features (see `Feature_base`) used as input by classification algorithms. This class handles both the instantiation, the addition and the deletion of features. @@ -63,7 +63,7 @@ public: /// @{ /*! - \brief Creates an empty feature set. + \brief creates an empty feature set. */ Feature_set() #ifdef CGAL_LINKED_WITH_TBB @@ -89,7 +89,7 @@ public: /// @{ /*! - \brief Instantiates a new feature and adds it to the set. + \brief instantiates a new feature and adds it to the set. If several calls of `add()` are surrounded by `begin_parallel_additions()` and `end_parallel_additions()`, they @@ -158,7 +158,7 @@ public: /*! - \brief Removes a feature. + \brief removes a feature. \param feature the handle to feature type that must be removed. @@ -177,7 +177,7 @@ public: } /*! - \brief Removes all features. + \brief removes all features. */ void clear () { @@ -193,7 +193,7 @@ public: #if defined(CGAL_LINKED_WITH_TBB) || defined(DOXYGEN_RUNNING) /*! - \brief Initializes structures to compute features in parallel. + \brief initializes structures to compute features in parallel. If the user wants to add features in parallel, this function should be called before making several calls of `add()`. After the @@ -217,7 +217,7 @@ public: /*! - \brief Waits for the end of parallel feature computation and + \brief waits for the end of parallel feature computation and clears dedicated data structures afterwards. If the user wants to add features in parallel, this function @@ -247,7 +247,7 @@ public: /// @{ /*! - \brief Returns how many features are defined. + \brief returns how many features are defined. */ std::size_t size() const { @@ -256,7 +256,7 @@ public: /*! - \brief Returns the \f$i^{th}\f$ feature. + \brief returns the \f$i^{th}\f$ feature. */ Feature_handle operator[](std::size_t i) const { diff --git a/Classification/include/CGAL/Classification/Label_set.h b/Classification/include/CGAL/Classification/Label_set.h index 33cc09dd5d4..76fd2d1dfad 100644 --- a/Classification/include/CGAL/Classification/Label_set.h +++ b/Classification/include/CGAL/Classification/Label_set.h @@ -25,7 +25,7 @@ namespace Classification { /*! \ingroup PkgClassificationLabel -\brief Set of `Label` used as input by classification +\brief sets of `Label` used as input by classification algorithms. */ @@ -39,7 +39,7 @@ public: Label_set() { } /*! - \brief Initializes the set with the provided `labels` names. + \brief initializes the set with the provided `labels` names. */ Label_set (const std::initializer_list& labels) { @@ -52,7 +52,7 @@ public: /// \endcond /*! - \brief Adds a label. + \brief adds a label. \note Names are not used for identification: two labels in the same set can have the same name (but not the same handle). @@ -69,7 +69,7 @@ public: } /*! - \brief Removes a label. + \brief removes a label. \param label the handle to the label that must be removed. @@ -93,7 +93,7 @@ public: } /*! - \brief Returns how many labels are defined. + \brief returns how many labels are defined. */ std::size_t size () const { @@ -101,7 +101,7 @@ public: } /*! - \brief Returns the \f$i^{th}\f$ label. + \brief returns the \f$i^{th}\f$ label. */ Label_handle operator[] (std::size_t i) const { @@ -110,7 +110,7 @@ public: /*! - \brief Removes all labels. + \brief removes all labels. */ void clear () { diff --git a/Classification/include/CGAL/Classification/Local_eigen_analysis.h b/Classification/include/CGAL/Classification/Local_eigen_analysis.h index e5da6b15b74..e156edbf63b 100644 --- a/Classification/include/CGAL/Classification/Local_eigen_analysis.h +++ b/Classification/include/CGAL/Classification/Local_eigen_analysis.h @@ -454,7 +454,7 @@ public: /// @{ /*! - \brief Returns the estimated unoriented normal vector of the point at position `index`. + \brief returns the estimated unoriented normal vector of the point at position `index`. \tparam GeomTraits model of \cgal Kernel. */ template @@ -467,7 +467,7 @@ public: } /*! - \brief Returns the estimated local tangent plane of the point at position `index`. + \brief returns the estimated local tangent plane of the point at position `index`. \tparam GeomTraits model of \cgal Kernel. */ template @@ -481,7 +481,7 @@ public: } /*! - \brief Returns the normalized eigenvalues of the point at position `index`. + \brief returns the normalized eigenvalues of the point at position `index`. */ Eigenvalues eigenvalue (std::size_t index) const { diff --git a/Classification/include/CGAL/Classification/Mesh_feature_generator.h b/Classification/include/CGAL/Classification/Mesh_feature_generator.h index 601b059c916..74228d279dc 100644 --- a/Classification/include/CGAL/Classification/Mesh_feature_generator.h +++ b/Classification/include/CGAL/Classification/Mesh_feature_generator.h @@ -55,7 +55,7 @@ namespace Classification { /*! \ingroup PkgClassificationMesh - \brief Generates a set of generic features for surface mesh + \brief generates a set of generic features for surface mesh classification. This class takes care of computing and storing all necessary data @@ -231,7 +231,7 @@ public: /// @{ /*! - \brief Initializes a feature generator from an input range. + \brief initializes a feature generator from an input range. If not provided by the user, The size of the smallest scale is automatically estimated using a method equivalent to @@ -301,7 +301,7 @@ public: /*! - \brief Generate geometric features based on face information. + \brief generates geometric features based on face information. At each scale, the following features are generated: @@ -320,7 +320,7 @@ public: } /*! - \brief Generate geometric features based on point position information. + \brief generates geometric features based on point position information. At each scale, the following features are generated by considering the mesh as a point cloud through `PointMap`: @@ -356,19 +356,19 @@ public: /// @{ /*! - \brief Returns the bounding box of the input point set. + \brief returns the bounding box of the input point set. */ const Iso_cuboid_3& bbox() const { return m_bbox; } /*! - \brief Returns the neighborhood structure at scale `scale`. + \brief returns the neighborhood structure at scale `scale`. */ const Neighborhood& neighborhood(std::size_t scale = 0) const { return (*m_scales[scale]->neighborhood); } /*! - \brief Returns the planimetric grid structure at scale `scale`. + \brief returns the planimetric grid structure at scale `scale`. */ const Planimetric_grid& grid(std::size_t scale = 0) const { return *(m_scales[scale]->grid); } /*! - \brief Returns the local eigen analysis structure at scale `scale`. + \brief returns the local eigen analysis structure at scale `scale`. */ const Local_eigen_analysis& eigen(std::size_t scale = 0) const { return *(m_scales[scale]->eigen); } @@ -378,26 +378,26 @@ public: /// @{ /*! - \brief Returns the number of scales that were computed. + \brief returns the number of scales that were computed. */ std::size_t number_of_scales() const { return m_scales.size(); } /*! - \brief Returns the grid resolution at scale `scale`. This + \brief returns the grid resolution at scale `scale`. This resolution is the length and width of a cell of the `Planimetric_grid` defined at this scale. */ float grid_resolution(std::size_t scale = 0) const { return m_scales[scale]->grid_resolution(); } /*! - \brief Returns the radius used for neighborhood queries at scale + \brief returns the radius used for neighborhood queries at scale `scale`. This radius is the smallest radius that is relevant from a geometric point of view at this scale (that is to say that encloses a few cells of `Planimetric_grid`). */ float radius_neighbors(std::size_t scale = 0) const { return m_scales[scale]->radius_neighbors(); } /*! - \brief Returns the radius used for digital terrain modeling at + \brief returns the radius used for digital terrain modeling at scale `scale`. This radius represents the minimum size of a building at this scale. */ diff --git a/Classification/include/CGAL/Classification/Mesh_neighborhood.h b/Classification/include/CGAL/Classification/Mesh_neighborhood.h index 9410e80ac14..170b61f411a 100644 --- a/Classification/include/CGAL/Classification/Mesh_neighborhood.h +++ b/Classification/include/CGAL/Classification/Mesh_neighborhood.h @@ -172,7 +172,7 @@ public: /// @{ /*! - \brief Returns a 1-ring neighbor query object. + \brief returns a 1-ring neighbor query object. */ One_ring_neighbor_query one_ring_neighbor_query () const { @@ -180,7 +180,7 @@ public: } /*! - \brief Returns an N-ring neighbor query object. + \brief returns an N-ring neighbor query object. */ N_ring_neighbor_query n_ring_neighbor_query (const std::size_t n) const { diff --git a/Classification/include/CGAL/Classification/OpenCV/Random_forest_classifier.h b/Classification/include/CGAL/Classification/OpenCV/Random_forest_classifier.h index 8500cfe5228..82f28fcf76e 100644 --- a/Classification/include/CGAL/Classification/OpenCV/Random_forest_classifier.h +++ b/Classification/include/CGAL/Classification/OpenCV/Random_forest_classifier.h @@ -71,7 +71,7 @@ public: /// @{ /*! - \brief Instantiates the classifier using the sets of `labels` and `features`. + \brief instantiates the classifier using the sets of `labels` and `features`. Parameters documentation is copy-pasted from [the official documentation of OpenCV](https://docs.opencv.org/2.4/modules/ml/doc/random_trees.html). For more details on this method, please refer to it. @@ -129,7 +129,7 @@ public: /// @{ /*! - \brief Runs the training algorithm. + \brief runs the training algorithm. From the set of provided ground truth, this algorithm estimates sets up the random trees that produce the most accurate result @@ -262,7 +262,7 @@ public: /*! - \brief Saves the current configuration in the file named `filename`. + \brief saves the current configuration in the file named `filename`. This allows to easily save and recover a specific classification configuration. @@ -276,7 +276,7 @@ public: } /*! - \brief Loads a configuration from the file named `filename`. + \brief loads a configuration from the file named `filename`. The input file should be in the XML format written by the `save_configuration()` method. The feature set of the classifier diff --git a/Classification/include/CGAL/Classification/Planimetric_grid.h b/Classification/include/CGAL/Classification/Planimetric_grid.h index 2fcec17160f..2bcf2045b6e 100644 --- a/Classification/include/CGAL/Classification/Planimetric_grid.h +++ b/Classification/include/CGAL/Classification/Planimetric_grid.h @@ -266,7 +266,7 @@ public: /*! - \brief Returns the resolution of the grid. + \brief returns the resolution of the grid. */ float resolution() const { @@ -274,14 +274,14 @@ public: } /*! - \brief Returns the number of cells along the X-axis. + \brief returns the number of cells along the X-axis. */ std::size_t width() const { return m_width; } /*! - \brief Returns the number of cells along the Y-axis. + \brief returns the number of cells along the Y-axis. */ std::size_t height() const { @@ -300,7 +300,7 @@ public: /// \endcond /*! - \brief Returns the begin iterator on the indices of the points + \brief returns the begin iterator on the indices of the points lying in the cell at position `(x,y)`. */ iterator indices_begin(std::size_t x, std::size_t y) const @@ -311,7 +311,7 @@ public: } /*! - \brief Returns the past-the-end iterator on the indices of the points + \brief returns the past-the-end iterator on the indices of the points lying in the cell at position `(x,y)`. */ iterator indices_end(std::size_t x, std::size_t y) const @@ -322,7 +322,7 @@ public: } /*! - \brief Returns `false` if the cell at position `(x,y)` is empty, `true` otherwise. + \brief returns `false` if the cell at position `(x,y)` is empty, `true` otherwise. */ bool has_points(std::size_t x, std::size_t y) const { @@ -336,7 +336,7 @@ public: } /*! - \brief Returns the `x` grid coordinate of the point at position `index`. + \brief returns the `x` grid coordinate of the point at position `index`. */ std::size_t x(std::size_t index) const { @@ -350,7 +350,7 @@ public: return m_lower_scale->x(index) / 2; } /*! - \brief Returns the `y` grid coordinate of the point at position `index`. + \brief returns the `y` grid coordinate of the point at position `index`. */ std::size_t y(std::size_t index) const { diff --git a/Classification/include/CGAL/Classification/Point_set_feature_generator.h b/Classification/include/CGAL/Classification/Point_set_feature_generator.h index e932b0a5975..f2fa500738b 100644 --- a/Classification/include/CGAL/Classification/Point_set_feature_generator.h +++ b/Classification/include/CGAL/Classification/Point_set_feature_generator.h @@ -57,7 +57,7 @@ namespace Classification { /*! \ingroup PkgClassificationPointSet - \brief Generates a set of generic features for point set + \brief generates a set of generic features for point set classification. This class takes care of computing and storing all necessary data @@ -233,7 +233,7 @@ public: /// @{ /*! - \brief Initializes a feature generator from an input range. + \brief initializes a feature generator from an input range. If not provided by the user, The size of the smallest scale is automatically estimated using a method equivalent to @@ -300,7 +300,7 @@ public: /*! - \brief Generate geometric features based on point position information. + \brief generates geometric features based on point position information. At each scale, the following features are generated: @@ -337,7 +337,7 @@ public: } /*! - \brief Generate geometric features based on normal vector information. + \brief generates geometric features based on normal vector information. Generates the version of `CGAL::Classification::Feature::Verticality` based on normal vectors. @@ -356,7 +356,7 @@ public: } /*! - \brief Generate geometric features based on point color information. + \brief generates geometric features based on point color information. Generates `CGAL::Classification::Feature::Color_channel` with channels `HUE`, `SATURATION` and `VALUE`. @@ -377,7 +377,7 @@ public: } /*! - \brief Generate geometric features based on echo information. + \brief generates geometric features based on echo information. At each scale, generates `CGAL::Classification::Feature::Echo_scatter`. @@ -402,19 +402,19 @@ public: /// @{ /*! - \brief Returns the bounding box of the input point set. + \brief returns the bounding box of the input point set. */ const Iso_cuboid_3& bbox() const { return m_bbox; } /*! - \brief Returns the neighborhood structure at scale `scale`. + \brief returns the neighborhood structure at scale `scale`. */ const Neighborhood& neighborhood(std::size_t scale = 0) const { return (*m_scales[scale]->neighborhood); } /*! - \brief Returns the planimetric grid structure at scale `scale`. + \brief returns the planimetric grid structure at scale `scale`. */ const Planimetric_grid& grid(std::size_t scale = 0) const { return *(m_scales[scale]->grid); } /*! - \brief Returns the local eigen analysis structure at scale `scale`. + \brief returns the local eigen analysis structure at scale `scale`. */ const Local_eigen_analysis& eigen(std::size_t scale = 0) const { return *(m_scales[scale]->eigen); } @@ -424,26 +424,26 @@ public: /// @{ /*! - \brief Returns the number of scales that were computed. + \brief returns the number of scales that were computed. */ std::size_t number_of_scales() const { return m_scales.size(); } /*! - \brief Returns the grid resolution at scale `scale`. This + \brief returns the grid resolution at scale `scale`. This resolution is the length and width of a cell of the `Planimetric_grid` defined at this scale. */ float grid_resolution(std::size_t scale = 0) const { return m_scales[scale]->grid_resolution(); } /*! - \brief Returns the radius used for neighborhood queries at scale + \brief returns the radius used for neighborhood queries at scale `scale`. This radius is the smallest radius that is relevant from a geometric point of view at this scale (that is to say that encloses a few cells of `Planimetric_grid`). */ float radius_neighbors(std::size_t scale = 0) const { return m_scales[scale]->radius_neighbors(); } /*! - \brief Returns the radius used for digital terrain modeling at + \brief returns the radius used for digital terrain modeling at scale `scale`. This radius represents the minimum size of a building at this scale. */ diff --git a/Classification/include/CGAL/Classification/Point_set_neighborhood.h b/Classification/include/CGAL/Classification/Point_set_neighborhood.h index fbbd376b7fb..40445bb1683 100644 --- a/Classification/include/CGAL/Classification/Point_set_neighborhood.h +++ b/Classification/include/CGAL/Classification/Point_set_neighborhood.h @@ -276,7 +276,7 @@ public: /// @{ /*! - \brief Returns a neighbor query object with fixed number of neighbors `k`. + \brief returns a neighbor query object with fixed number of neighbors `k`. */ K_neighbor_query k_neighbor_query (const unsigned int k) const { @@ -284,7 +284,7 @@ public: } /*! - \brief Returns a neighbor query object with fixed radius `radius`. + \brief returns a neighbor query object with fixed radius `radius`. */ Sphere_neighbor_query sphere_neighbor_query (const float radius) const { diff --git a/Classification/include/CGAL/Classification/Sum_of_weighted_features_classifier.h b/Classification/include/CGAL/Classification/Sum_of_weighted_features_classifier.h index 7d80da5fd62..2cbcd97c655 100644 --- a/Classification/include/CGAL/Classification/Sum_of_weighted_features_classifier.h +++ b/Classification/include/CGAL/Classification/Sum_of_weighted_features_classifier.h @@ -163,7 +163,7 @@ public: /*! - \brief Instantiates the classifier using the sets of `labels` and `features`. + \brief instantiates the classifier using the sets of `labels` and `features`. \note If the label set of the feature set are modified after instantiating this object (addition of removal of a label and/or of @@ -190,7 +190,7 @@ public: /// @{ /*! - \brief Sets the weight of `feature` (`weight` must be positive). + \brief sets the weight of `feature` (`weight` must be positive). */ void set_weight (Feature_handle feature, float weight) { @@ -204,7 +204,7 @@ public: /// \endcond /*! - \brief Returns the weight of `feature`. + \brief returns the weight of `feature`. */ float weight (Feature_handle feature) const { @@ -218,7 +218,7 @@ public: /// \endcond /*! - \brief Sets the `effect` of `feature` on `label`. + \brief sets the `effect` of `feature` on `label`. */ void set_effect (Label_handle label, Feature_handle feature, Effect effect) @@ -234,7 +234,7 @@ public: /// \endcond /*! - \brief Returns the `effect` of `feature` on `label`. + \brief returns the `effect` of `feature` on `label`. */ Effect effect (Label_handle label, Feature_handle feature) const { @@ -269,7 +269,7 @@ public: /// @{ /*! - \brief Runs the training algorithm. + \brief runs the training algorithm. From the set of provided ground truth, this algorithm estimates the sets of weights and effects that produce the most accurate @@ -636,7 +636,7 @@ public: /// @{ /*! - \brief Saves the current configuration in the stream `output`. + \brief saves the current configuration in the stream `output`. This allows to easily save and recover a specific classification configuration, that is to say: @@ -694,7 +694,7 @@ public: } /*! - \brief Loads a configuration from the stream `input`. A + \brief loads a configuration from the stream `input`. A configuration is a set of weights and effects. The input file should be in the XML format written by the diff --git a/Classification/include/CGAL/Classification/TensorFlow/Neural_network_classifier.h b/Classification/include/CGAL/Classification/TensorFlow/Neural_network_classifier.h index c2c4b0860b8..d25a89fb972 100644 --- a/Classification/include/CGAL/Classification/TensorFlow/Neural_network_classifier.h +++ b/Classification/include/CGAL/Classification/TensorFlow/Neural_network_classifier.h @@ -113,7 +113,7 @@ public: /// @{ /*! - \brief Instantiates the classifier using the sets of `labels` and `features`. + \brief instantiates the classifier using the sets of `labels` and `features`. */ Neural_network_classifier (const Label_set& labels, @@ -204,7 +204,7 @@ public: /// @{ /*! - \brief Runs the training algorithm. + \brief runs the training algorithm. From the set of provided ground truth, this algorithm constructs a neural network and applies an Adam optimizer to set up the weights @@ -446,7 +446,7 @@ public: /// @{ /*! - \brief Saves the current configuration in the stream `output`. + \brief saves the current configuration in the stream `output`. This allows to easily save and recover a specific classification configuration, that is to say: @@ -527,7 +527,7 @@ public: } /*! - \brief Loads a configuration from the stream `input`. + \brief loads a configuration from the stream `input`. The input file should be in the XML format written by the `save_configuration()` method. The feature set of the classifier diff --git a/Classification/include/CGAL/Classification/classify.h b/Classification/include/CGAL/Classification/classify.h index 9928ca808a3..25b1d5dae7a 100644 --- a/Classification/include/CGAL/Classification/classify.h +++ b/Classification/include/CGAL/Classification/classify.h @@ -320,7 +320,7 @@ namespace internal { /*! \ingroup PkgClassificationMain - \brief Runs the classification algorithm without any regularization. + \brief runs the classification algorithm without any regularization. There is no relationship between items, the classification energy is only minimized itemwise. This method is quick but produces @@ -410,7 +410,7 @@ namespace internal { /*! \ingroup PkgClassificationMain - \brief Runs the classification algorithm with a local smoothing. + \brief runs the classification algorithm with a local smoothing. The computed classification energy is smoothed on a user defined local neighborhood of items. This method is a compromise between @@ -480,7 +480,7 @@ namespace internal { /*! \ingroup PkgClassificationMain - \brief Runs the classification algorithm with a global + \brief runs the classification algorithm with a global regularization based on a graph cut. The computed classification energy is globally regularized through diff --git a/Cone_spanners_2/include/CGAL/Cone_spanners_enum_2.h b/Cone_spanners_2/include/CGAL/Cone_spanners_enum_2.h index d95d5e0dd69..82e29a58769 100644 --- a/Cone_spanners_2/include/CGAL/Cone_spanners_enum_2.h +++ b/Cone_spanners_2/include/CGAL/Cone_spanners_enum_2.h @@ -27,13 +27,13 @@ namespace CGAL { \brief An enum of the choice of cones in cone spanners. */ enum Cones_selected { - /*! \brief Select even cones. + /*! \brief selects even cones. */ EVEN_CONES = 0, - /*! \brief Select odd cones. + /*! \brief selects odd cones. */ ODD_CONES = 1, - /*! \brief Select all cones. + /*! \brief selects all cones. */ ALL_CONES = 2 }; diff --git a/Cone_spanners_2/include/CGAL/gnuplot_output_2.h b/Cone_spanners_2/include/CGAL/gnuplot_output_2.h index dc7b7e91449..65324f60134 100644 --- a/Cone_spanners_2/include/CGAL/gnuplot_output_2.h +++ b/Cone_spanners_2/include/CGAL/gnuplot_output_2.h @@ -38,7 +38,7 @@ namespace CGAL { /*! * \ingroup PkgConeSpanners2Ref -* \brief Output a set of files used by Gnuplot to plot `g`. +* \brief outputs a set of files used by Gnuplot to plot `g`. * * The files that are generated for Gnuplot are: * (1) prefix.v (vertex list) diff --git a/Mesh_3/doc/Mesh_3/CGAL/IO/File_medit.h b/Mesh_3/doc/Mesh_3/CGAL/IO/File_medit.h index 69966bf22b5..62bb1476d86 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/IO/File_medit.h +++ b/Mesh_3/doc/Mesh_3/CGAL/IO/File_medit.h @@ -2,7 +2,7 @@ namespace CGAL { /// \ingroup PkgMesh3IOFunctions /// -/// \brief Outputs a mesh complex to the medit (`.mesh`) file format. +/// \brief outputs a mesh complex to the medit (`.mesh`) file format. /// See \cgalCite{frey:inria-00069921} for a comprehensive description of this file format. /// /// \param os the output stream diff --git a/Modular_arithmetic/include/CGAL/Modular_arithmetic/Residue_type.h b/Modular_arithmetic/include/CGAL/Modular_arithmetic/Residue_type.h index 2de2a1deedb..ac3fc8633c8 100644 --- a/Modular_arithmetic/include/CGAL/Modular_arithmetic/Residue_type.h +++ b/Modular_arithmetic/include/CGAL/Modular_arithmetic/Residue_type.h @@ -197,7 +197,7 @@ public: return old_prime; } - /*! \brief return the current prime. */ + /*! \brief returns the current prime. */ static int get_current_prime(){ return get_prime_int(); } diff --git a/Modular_arithmetic/include/CGAL/Residue.h b/Modular_arithmetic/include/CGAL/Residue.h index ab862ec9766..296f1fb3ef4 100644 --- a/Modular_arithmetic/include/CGAL/Residue.h +++ b/Modular_arithmetic/include/CGAL/Residue.h @@ -10,7 +10,7 @@ // Author(s) : Michael Hemmer /*! \file CGAL/Residue.h - \brief Defines the class CGAL::Residue and CGAL::Modular_traits. + \brief defines the class CGAL::Residue and CGAL::Modular_traits. Provides the \c CGAL::Modular_traits specialization for the build in number types. diff --git a/Number_types/include/CGAL/Gmp_coercion_traits.h b/Number_types/include/CGAL/Gmp_coercion_traits.h index d3e5d6f00b9..e6c0f34522d 100644 --- a/Number_types/include/CGAL/Gmp_coercion_traits.h +++ b/Number_types/include/CGAL/Gmp_coercion_traits.h @@ -12,7 +12,7 @@ /*! \file NiX/Gmp/Coercion_traits.h - * \brief Provides specializations of Coercion_traits for the Gmp types. + * \brief provides specializations of Coercion_traits for the Gmp types. */ #ifndef CGAL_GMP_COERCION_TRAITS_H diff --git a/Number_types/include/CGAL/Sqrt_extension/Sqrt_extension_type.h b/Number_types/include/CGAL/Sqrt_extension/Sqrt_extension_type.h index 902a297d9d9..ff676eb45c2 100644 --- a/Number_types/include/CGAL/Sqrt_extension/Sqrt_extension_type.h +++ b/Number_types/include/CGAL/Sqrt_extension/Sqrt_extension_type.h @@ -16,7 +16,7 @@ /*! \file CGAL/Sqrt_extension.h - \brief Defines class CGAL::Sqrt_extension. + \brief defines class CGAL::Sqrt_extension. Provides the Number type Sqrt_extension that extends a given number type \c NT by a square root. One can add several square roots recursively. @@ -146,7 +146,7 @@ public: - /*! \brief Expicite constructor of Sqrt_extension, from + /*! \brief Explicit constructor of Sqrt_extension, from * \c Sqrt_extension. * \pre NT must constructible from NTX * \pre ROOT must constructible from ROOTX */ diff --git a/Number_types/include/CGAL/gmpxx_coercion_traits.h b/Number_types/include/CGAL/gmpxx_coercion_traits.h index 90bb7dc3ed7..119f96f2904 100644 --- a/Number_types/include/CGAL/gmpxx_coercion_traits.h +++ b/Number_types/include/CGAL/gmpxx_coercion_traits.h @@ -13,7 +13,7 @@ /*! \file NiX/Gmp/Coercion_traits.h - * \brief Provides specializations of Coercion_traits for the Gmp types. + * \brief provides specializations of Coercion_traits for the Gmp types. */ #ifndef CGAL_GMPXX_COERCION_TRAITS_H diff --git a/Number_types/include/CGAL/leda_coercion_traits.h b/Number_types/include/CGAL/leda_coercion_traits.h index ed299fc478a..442d6951935 100644 --- a/Number_types/include/CGAL/leda_coercion_traits.h +++ b/Number_types/include/CGAL/leda_coercion_traits.h @@ -12,7 +12,7 @@ /*! \file NiX/LEDA/Coercion_traits.h - * \brief Provides specializations of Coercion_traits for the LEDA number types. + * \brief provides specializations of Coercion_traits for the LEDA number types. */ #ifndef CGAL_LEDA_COERCION_TRAITS_H diff --git a/Periodic_3_mesh_3/doc/Periodic_3_mesh_3/CGAL/Periodic_3_mesh_3/IO/File_medit.h b/Periodic_3_mesh_3/doc/Periodic_3_mesh_3/CGAL/Periodic_3_mesh_3/IO/File_medit.h index e252de45571..a09fb753f34 100644 --- a/Periodic_3_mesh_3/doc/Periodic_3_mesh_3/CGAL/Periodic_3_mesh_3/IO/File_medit.h +++ b/Periodic_3_mesh_3/doc/Periodic_3_mesh_3/CGAL/Periodic_3_mesh_3/IO/File_medit.h @@ -2,7 +2,7 @@ namespace CGAL { /// \ingroup PkgPeriodic3Mesh3IOFunctions /// -/// \brief Outputs a periodic mesh to the medit (`.mesh`) file format. +/// \brief outputs a periodic mesh to the medit (`.mesh`) file format. /// See \cgalCite{frey:inria-00069921} for a comprehensive description of this file format. /// /// \param os the output stream diff --git a/Periodic_3_mesh_3/include/CGAL/Periodic_3_mesh_3/IO/File_medit.h b/Periodic_3_mesh_3/include/CGAL/Periodic_3_mesh_3/IO/File_medit.h index 7c07c643eda..63c2b6bb934 100644 --- a/Periodic_3_mesh_3/include/CGAL/Periodic_3_mesh_3/IO/File_medit.h +++ b/Periodic_3_mesh_3/include/CGAL/Periodic_3_mesh_3/IO/File_medit.h @@ -331,7 +331,7 @@ void output_to_medit(std::ostream& os, } // namespace Periodic_3_mesh_3 /** - * \brief Outputs a periodic mesh to the .mesh file format, which can be visualized + * \brief outputs a periodic mesh to the .mesh file format, which can be visualized * using medit. By default, 7 copies are used, for a total of 8 instances of the domains. * \param os the stream * \param c3t3 the mesh diff --git a/Periodic_3_triangulation_3/include/CGAL/Periodic_3_triangulation_3.h b/Periodic_3_triangulation_3/include/CGAL/Periodic_3_triangulation_3.h index c96cb05bc11..48002f4a7c3 100644 --- a/Periodic_3_triangulation_3/include/CGAL/Periodic_3_triangulation_3.h +++ b/Periodic_3_triangulation_3/include/CGAL/Periodic_3_triangulation_3.h @@ -92,7 +92,7 @@ struct Periodic_structural_filtering_selector_3 /**\class Periodic_3_triangulation_3 * - * \brief Implements functionality for computing in periodic space. + * \brief implements functionality for computing in periodic space. * * There are several things that are special to computing in $\mathbb{T}^3$ * such as @@ -2498,7 +2498,7 @@ inline Bounded_side Periodic_3_triangulation_3::side_of_cell( } } // side_of_cell -/*! \brief Insert point. +/*! \brief inserts point. * * Inserts the point p into the triangulation. It assumes that * the cell c containing p is already known. @@ -2829,7 +2829,7 @@ find_conflicts(Cell_handle d, const Offset& current_off, return it; } -/*! \brief Insert point into triangulation. +/*! \brief inserts point into triangulation. * * Inserts the point p into the triangulation. It expects * - a cell to start the point location @@ -2939,7 +2939,7 @@ inline bool Periodic_3_triangulation_3::has_self_edges(Cell_handle c) co (c->vertex(2) == c->vertex(3))); } -/*! \brief Tests if the triangulation is valid. +/*! \brief tests if the triangulation is valid. * * A triangulation is valid if * - A cell is not its own neighbor. @@ -3087,7 +3087,7 @@ inline void Periodic_3_triangulation_3::make_hole(Vertex_handle v, } } -/*! \brief Remove a vertex from the triangulation. +/*! \brief removes a vertex from the triangulation. * * Removes vertex v from the triangulation. */ @@ -3128,7 +3128,7 @@ remove(Vertex_handle v, PointRemover& r, Conflict_tester& t, CoverManager& cover } } -/*! \brief Remove a vertex from the triangulation. +/*! \brief removes a vertex from the triangulation. * * Removes vertex v from the triangulation. * It expects a reference to an instance of a PointRemover. @@ -3340,7 +3340,7 @@ periodic_remove(Vertex_handle v, PointRemover& remover, CoverManager& cover_mana // ############################################################################ // ############################################################################ -/** \brief Delete each redundant cell and the not anymore needed data +/** \brief deletes each redundant cell and the not anymore needed data * structures. * * This function consists of four iterations over all cells and one @@ -3859,7 +3859,7 @@ Periodic_3_triangulation_3::get_cell(const Vertex_handle* vh) const return Cell_handle(); } -/*! \brief Get the offset of tester.point() such that +/*! \brief gets the offset of tester.point() such that * this point is in conflict with c w.r.t tester.get_offset(). * * Implementation: Just try all eight possibilities. diff --git a/Periodic_4_hyperbolic_triangulation_2/include/CGAL/Periodic_4_hyperbolic_triangulation_2.h b/Periodic_4_hyperbolic_triangulation_2/include/CGAL/Periodic_4_hyperbolic_triangulation_2.h index a6e6d7aceeb..76879a19464 100644 --- a/Periodic_4_hyperbolic_triangulation_2/include/CGAL/Periodic_4_hyperbolic_triangulation_2.h +++ b/Periodic_4_hyperbolic_triangulation_2/include/CGAL/Periodic_4_hyperbolic_triangulation_2.h @@ -671,7 +671,7 @@ has_cycles_length_2(typename TDS::Vertex_handle v) const return false; } -/*! \brief Tests if the triangulation is valid. +/*! \brief tests if the triangulation is valid. * * A triangulation is valid if * - A cell is not its own neighbor. diff --git a/Point_set_3/include/CGAL/Point_set_3.h b/Point_set_3/include/CGAL/Point_set_3.h index 4944a28489f..8748cd51597 100644 --- a/Point_set_3/include/CGAL/Point_set_3.h +++ b/Point_set_3/include/CGAL/Point_set_3.h @@ -207,7 +207,7 @@ public: /*! - \brief Creates an empty point set with no additional property. + \brief creates an empty point set with no additional property. \param with_normal_map `true` if the normal map should be added. If `false` (default value), the normal map can still be @@ -258,7 +258,7 @@ public: /*! - \brief Returns `true` if the number of elements not marked as + \brief returns `true` if the number of elements not marked as removed is 0, `false` otherwise. \note This does not count the removed elements. @@ -271,7 +271,7 @@ public: bool empty() const { return is_empty(); } /// \endcond /*! - \brief Returns the number of elements (not counting elements marked as removed). + \brief returns the number of elements (not counting elements marked as removed). \note See `number_of_removed_points()` for getting the number of elements marked as removed. @@ -284,7 +284,7 @@ public: /// \endcond /*! - \brief Merges `other` in the point set. + \brief merges `other` in the point set. Shifts the indices of points of `other` by `number_of_points() + other.number_of_points()`. @@ -347,7 +347,7 @@ public: } /*! - \brief Increases the capacity of internal containers to be able to + \brief increases the capacity of internal containers to be able to efficiently accommodate at least `s` elements \param s Expected final number of elements. @@ -358,7 +358,7 @@ public: void reserve (std::size_t s) { m_base.reserve (s); } /*! - \brief Changes size of the point set. + \brief changes size of the point set. \param s Target size of the point set @@ -398,7 +398,7 @@ public: /// @{ /*! - \brief Inserts a new element with default property values. + \brief inserts a new element with default property values. \return The iterator on the newly added element. @@ -428,7 +428,7 @@ public: } /*! - \brief Inserts new point with default property values. + \brief inserts new point with default property values. \param p Point to insert @@ -516,40 +516,40 @@ public: /// @{ /*! - \brief Returns the begin iterator. + \brief returns the begin iterator. */ iterator begin() { return m_indices.begin(); } /*! - \brief Returns the past-the-end iterator. + \brief returns the past-the-end iterator. \note The returned value is the same as `garbage_begin()`. */ iterator end() { return m_indices.end() - m_nb_removed; } /*! - \brief Returns the begin constant iterator. + \brief returns the begin constant iterator. */ const_iterator begin() const { return m_indices.begin(); } /*! - \brief Returns the past-the-end constant iterator. + \brief returns the past-the-end constant iterator. \note The returned value is the same as `garbage_begin()`. */ const_iterator end() const { return m_indices.end() - m_nb_removed; } /*! - \brief Returns a reference to the point corresponding to `index`. + \brief returns a reference to the point corresponding to `index`. */ Point& point (const Index& index) { return m_points[index]; } /*! - \brief Returns a constant reference to the point corresponding to `index`. + \brief returns a constant reference to the point corresponding to `index`. */ const Point& point (const Index& index) const { return m_points[index]; } /*! - \brief Returns a reference to the normal corresponding to `index`. + \brief returns a reference to the normal corresponding to `index`. \note The normal property must have been added to the point set before calling this method (see `add_normal_map()`). */ Vector& normal (const Index& index) { return m_normals[index]; } /*! - \brief Returns a constant reference to the normal corresponding to `index`. + \brief returns a constant reference to the normal corresponding to `index`. \note The normal property must have been added to the point set before calling this method (see `add_normal_map()`). @@ -562,7 +562,7 @@ public: /// @{ /*! - \brief Marks all elements between `first` and `last` as removed. + \brief marks all elements between `first` and `last` as removed. \note The elements are just marked as removed and are not erased from the memory. `collect_garbage()` should be called if the @@ -601,7 +601,7 @@ public: /// \endcond /*! - \brief Marks element specified by iterator as removed. + \brief marks element specified by iterator as removed. \note The element is just marked as removed and is not erased from the memory. `collect_garbage()` should be called if the memory @@ -618,7 +618,7 @@ public: } /*! - \brief Marks element specified by `Index` as removed. + \brief marks element specified by `Index` as removed. \note The element is just marked as removed and is not erased from the memory. `collect_garbage()` should be called if the memory @@ -643,7 +643,7 @@ public: /// @{ /*! - \brief Returns `true` if the element is marked as removed, `false` + \brief returns `true` if the element is marked as removed, `false` otherwise. \note When iterating between `begin()` and `end()`, no element @@ -655,7 +655,7 @@ public: } /*! - \brief Returns `true` if the element is marked as removed, `false` + \brief returns `true` if the element is marked as removed, `false` otherwise. \note When iterating between `begin()` and `end()`, no element @@ -670,12 +670,12 @@ public: } /*! - \brief Returns the constant iterator to the first element marked as removed + \brief returns the constant iterator to the first element marked as removed (equal to `garbage_end()` if no elements are marked as removed. */ const_iterator garbage_begin () const { return m_indices.end() - m_nb_removed; } /*! - \brief Returns the past-the-end constant iterator of the elements marked as removed. + \brief returns the past-the-end constant iterator of the elements marked as removed. */ const_iterator garbage_end () const { return m_indices.end(); } /*! @@ -690,13 +690,13 @@ public: std::size_t garbage_size () const { return number_of_removed_points(); } /// \endcond - /*! \brief Returns `true` if there are elements marked as removed, + /*! \brief returns `true` if there are elements marked as removed, `false` otherwise. */ bool has_garbage () const { return (m_nb_removed != 0); } /*! - \brief Erases from memory the elements marked as removed. + \brief erases from memory the elements marked as removed. */ void collect_garbage () { @@ -718,7 +718,7 @@ public: } /*! - \brief Restores all removed points. + \brief restores all removed points. After removing one or several points, calling this method restores the point set to its initial state: points that were removed (and @@ -759,7 +759,7 @@ public: /*! - \brief Tests whether property `name` of type `T` already exists. + \brief tests whether property `name` of type `T` already exists. \tparam T type of the property. @@ -774,7 +774,7 @@ public: } /*! - \brief Adds a new property `name` of type `T` with given default value. + \brief adds a new property `name` of type `T` with given default value. \tparam T type of the property. @@ -797,7 +797,7 @@ public: } /*! - \brief Returns the property `name` of type `T`. + \brief returns the property `name` of type `T`. \tparam T type of the property. @@ -818,7 +818,7 @@ public: } /*! - \brief Removes the specified property. + \brief removes the specified property. \tparam T type of the property. @@ -861,7 +861,7 @@ public: return std::make_pair (m_normals, out); } /*! - \brief Returns the property map of the normal property. + \brief returns the property map of the normal property. \note The normal property must have been added to the point set before calling this method (see `add_normal_map()`). @@ -871,7 +871,7 @@ public: return m_normals; } /*! - \brief Returns the property map of the normal property (constant version). + \brief returns the property map of the normal property (constant version). \note The normal property must have been added to the point set before calling this method (see `add_normal_map()`). @@ -891,7 +891,7 @@ public: return m_base.template remove (m_normals); } /*! - \brief Returns the property map of the point property. + \brief returns the property map of the point property. */ Point_map point_map() { @@ -899,7 +899,7 @@ public: } /*! - \brief Returns the property map of the point property (constant version). + \brief returns the property map of the point property (constant version). */ const Point_map point_map() const { @@ -922,7 +922,7 @@ public: /*! - \brief Returns a vector with all strings that describe properties. + \brief returns a vector with all strings that describe properties. */ std::vector properties() const { @@ -933,7 +933,7 @@ public: } /*! - \brief Returns a vector of pairs that describe properties and associated types. + \brief returns a vector of pairs that describe properties and associated types. */ std::vector > properties_and_types() const { @@ -949,7 +949,7 @@ public: /*! - \brief Returns a sequence of \ref bgl_namedparameters "Named Parameters" to be used in Point Set Processing algorithms. + \brief returns a sequence of \ref bgl_namedparameters "Named Parameters" to be used in Point Set Processing algorithms. The following named parameters are used: - `point_map`: contains the point property map (see `point_map()`) @@ -1009,7 +1009,7 @@ public: #endif /*! - \brief Returns a property as a range. + \brief returns a property as a range. */ template Property_range range (const Property_map& pmap) const @@ -1018,7 +1018,7 @@ public: } /*! - \brief Returns a constant range of points. + \brief returns a constant range of points. */ Point_range points () const { @@ -1026,7 +1026,7 @@ public: } /*! - \brief Returns a constant range of normals. + \brief returns a constant range of normals. */ Vector_range normals () const { @@ -1160,7 +1160,7 @@ public: /*! \cgalAdvancedFunction \cgalAdvancedBegin - \brief Returns the push property map of the given property. + \brief returns the push property map of the given property. \tparam T type of the property. @@ -1180,7 +1180,7 @@ public: /*! \cgalAdvancedFunction \cgalAdvancedBegin - \brief Returns the push property map of the point property. + \brief returns the push property map of the point property. \cgalAdvancedEnd */ Point_push_map point_push_map () @@ -1190,7 +1190,7 @@ public: /*! \cgalAdvancedFunction \cgalAdvancedBegin - \brief Returns the push property map of the normal property. + \brief returns the push property map of the normal property. \note The normal property must have been added to the point set before calling this method (see `add_normal_map()`). @@ -1203,7 +1203,7 @@ public: /*! \cgalAdvancedFunction \cgalAdvancedBegin - \brief Returns the back inserter on the index property. + \brief returns the back inserter on the index property. \cgalAdvancedEnd */ Index_back_inserter index_back_inserter () @@ -1213,7 +1213,7 @@ public: /*! \cgalAdvancedFunction \cgalAdvancedBegin - \brief Returns the back inserter on the point property. + \brief returns the back inserter on the point property. \cgalAdvancedEnd */ Point_back_inserter point_back_inserter () diff --git a/Point_set_3/include/CGAL/Point_set_3/IO.h b/Point_set_3/include/CGAL/Point_set_3/IO.h index 4bad70e4002..5954bee818e 100644 --- a/Point_set_3/include/CGAL/Point_set_3/IO.h +++ b/Point_set_3/include/CGAL/Point_set_3/IO.h @@ -34,7 +34,7 @@ namespace CGAL { /*! \ingroup PkgPointSet3IO - \brief Reads the point set from an input stream that can be either: + \brief reads the point set from an input stream that can be either: - \link IOStreamXYZ XYZ \endlink - \link IOStreamOFF OFF \endlink @@ -82,7 +82,7 @@ std::istream& operator>>(std::istream& is, /*! \ingroup PkgPointSet3IO - \brief Reads the point set from an input file that can be either: + \brief reads the point set from an input file that can be either: - \link IOStreamXYZ XYZ \endlink - \link IOStreamOFF OFF \endlink @@ -135,7 +135,7 @@ bool read_point_set(const char* filename, CGAL::Point_set_3& ps) /*! \ingroup PkgPointSet3IO - \brief Inserts the point set in an output stream in ASCII PLY format. + \brief inserts the point set in an output stream in ASCII PLY format. All properties are inserted in their instantiation order. \tparam Point a `CGAL::Point_3` @@ -159,7 +159,7 @@ std::ostream& operator<<(std::ostream& os, /*! \ingroup PkgPointSet3IO - \brief Inserts the point set in an output file that can be either: + \brief inserts the point set in an output file that can be either: - \link IOStreamXYZ XYZ \endlink - \link IOStreamOFF OFF \endlink diff --git a/Point_set_3/include/CGAL/Point_set_3/IO/LAS.h b/Point_set_3/include/CGAL/Point_set_3/IO/LAS.h index 011463803a8..c4a2e977045 100644 --- a/Point_set_3/include/CGAL/Point_set_3/IO/LAS.h +++ b/Point_set_3/include/CGAL/Point_set_3/IO/LAS.h @@ -60,7 +60,7 @@ void check_if_property_is_used(PointSet& point_set, /*! \ingroup PkgPointSet3IO - \brief Reads the content of an intput stream in the \ref IOStreamLAS into a point set. + \brief reads the content of an intput stream in the \ref IOStreamLAS into a point set. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -154,7 +154,7 @@ bool read_LAS(std::istream& is, /*! \ingroup PkgPointSet3IO - \brief Reads the content of an intput stream in the \ref IOStreamLAS into a point set. + \brief reads the content of an intput stream in the \ref IOStreamLAS into a point set. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -201,7 +201,7 @@ CGAL_DEPRECATED bool read_las_point_set(std::istream& is, ///< input stream. /*! \ingroup PkgPointSet3IO - \brief Writes the content of a point set into an output stream in the \ref IOStreamLAS. + \brief writes the content of a point set into an output stream in the \ref IOStreamLAS. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -404,7 +404,7 @@ bool write_LAS(std::ostream& os, CGAL::Point_set_3& point_set) /*! \ingroup PkgPointSet3IO - \brief Writes the content of a point set into an output file in the \ref IOStreamLAS. + \brief writes the content of a point set into an output file in the \ref IOStreamLAS. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` diff --git a/Point_set_3/include/CGAL/Point_set_3/IO/OFF.h b/Point_set_3/include/CGAL/Point_set_3/IO/OFF.h index 1129bb971ba..ec17c26215f 100644 --- a/Point_set_3/include/CGAL/Point_set_3/IO/OFF.h +++ b/Point_set_3/include/CGAL/Point_set_3/IO/OFF.h @@ -41,7 +41,7 @@ class Point_set_3; /*! \ingroup PkgPointSet3IO - \brief Reads the content of an intput stream in the \ref IOStreamOFF into a point set. + \brief reads the content of an intput stream in the \ref IOStreamOFF into a point set. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -80,7 +80,7 @@ bool read_OFF(std::istream& is, /*! \ingroup PkgPointSet3IO - \brief Reads the content of an input file in the \ref IOStreamOFF into a point set. + \brief reads the content of an input file in the \ref IOStreamOFF into a point set. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -127,7 +127,7 @@ CGAL_DEPRECATED bool read_off_point_set(std::istream& is, ///< input stream. /*! \ingroup PkgPointSet3IO - \brief Writes the content of a point set into an output stream in the \ref IOStreamOFF. + \brief writes the content of a point set into an output stream in the \ref IOStreamOFF. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -170,7 +170,7 @@ bool write_OFF(std::ostream& os, const CGAL::Point_set_3& point_s /*! \ingroup PkgPointSet3IO - \brief Writes the content of a point set into an output file in the \ref IOStreamOFF. + \brief writes the content of a point set into an output file in the \ref IOStreamOFF. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` diff --git a/Point_set_3/include/CGAL/Point_set_3/IO/PLY.h b/Point_set_3/include/CGAL/Point_set_3/IO/PLY.h index a4fc334138f..923698848af 100644 --- a/Point_set_3/include/CGAL/Point_set_3/IO/PLY.h +++ b/Point_set_3/include/CGAL/Point_set_3/IO/PLY.h @@ -224,7 +224,7 @@ public: /*! \ingroup PkgPointSet3IO - \brief Reads a point set with properties from an input stream in ASCII or Binary \ref IOStreamPLY. + \brief reads a point set with properties from an input stream in ASCII or Binary \ref IOStreamPLY. - the operator reads the vertex `point` property; - if three PLY properties `nx`, `ny` and `nz` with type `float` @@ -309,7 +309,7 @@ bool read_PLY(std::istream& is, CGAL::Point_set_3& point_set) /*! \ingroup PkgPointSet3IO - \brief Reads a point set with properties from an input stream in ASCII or Binary \ref IOStreamPLY. + \brief reads a point set with properties from an input stream in ASCII or Binary \ref IOStreamPLY. - the operator reads the vertex `point` property; - if three PLY properties `nx`, `ny` and `nz` with type `float` @@ -410,7 +410,7 @@ bool read_PLY(const std::string& fname, CGAL::Point_set_3& point_ \deprecated This function is deprecated since \cgal 5.2, \link PkgPointSet3IO `CGAL::read_PLY()` \endlink should be used instead. - \brief Reads a point set with properties from an input stream in ASCII or Binary PLY format. + \brief reads a point set with properties from an input stream in ASCII or Binary PLY format. - the operator reads the vertex `point` property; - if three PLY properties `nx`, `ny` and `nz` with type `float` @@ -448,7 +448,7 @@ CGAL_DEPRECATED bool read_ply_point_set(std::istream& is, ///< input stream. /*! \ingroup PkgPointSet3IO - \brief Writes a point set with properties in an output stream in the \ref IOStreamPLY. + \brief writes a point set with properties in an output stream in the \ref IOStreamPLY. If found, the normal map is inserted to the stream. All other properties with simple types are inserted in the stream. @@ -715,7 +715,7 @@ bool write_PLY(std::ostream& os, const CGAL::Point_set_3& point_s /*! \ingroup PkgPointSet3IO - \brief Writes a point set with properties in an output stream in the \ref IOStreamPLY. + \brief writes a point set with properties in an output stream in the \ref IOStreamPLY. If found, the normal map is inserted to the stream. All other properties with simple types are inserted in the stream. diff --git a/Point_set_3/include/CGAL/Point_set_3/IO/XYZ.h b/Point_set_3/include/CGAL/Point_set_3/IO/XYZ.h index aa6c4b857e1..85bbb918510 100644 --- a/Point_set_3/include/CGAL/Point_set_3/IO/XYZ.h +++ b/Point_set_3/include/CGAL/Point_set_3/IO/XYZ.h @@ -40,7 +40,7 @@ class Point_set_3; /*! \ingroup PkgPointSet3IO - \brief Reads the content of an intput stream in the \ref IOStreamXYZ into a point set. + \brief reads the content of an intput stream in the \ref IOStreamXYZ into a point set. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -79,7 +79,7 @@ bool read_XYZ(std::istream& is, /*! \ingroup PkgPointSet3IO - \brief Reads the content of an input file in the the \ref IOStreamXYZ into a point set. + \brief reads the content of an input file in the the \ref IOStreamXYZ into a point set. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -125,7 +125,7 @@ CGAL_DEPRECATED bool read_xyz_point_set(std::istream& is, CGAL::Point_set_3& point_s /*! \ingroup PkgPointSet3IO - \brief Writes the content of a point set into an output file in the \ref IOStreamXYZ. + \brief writes the content of a point set into an output file in the \ref IOStreamXYZ. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` diff --git a/Point_set_processing_3/include/CGAL/IO/read_las_points.h b/Point_set_processing_3/include/CGAL/IO/read_las_points.h index e6b5b0187cc..ef5c2c5b35b 100644 --- a/Point_set_processing_3/include/CGAL/IO/read_las_points.h +++ b/Point_set_processing_3/include/CGAL/IO/read_las_points.h @@ -318,7 +318,7 @@ void process_properties (const LASpoint& reader, OutputValueType& new_element, /** \ingroup PkgPointSetProcessing3IOLas - \brief Reads user-selected points properties from a .las or .laz stream. + \brief reads user-selected points properties from a .las or .laz stream. Potential additional properties are ignored. Properties are handled through a variadic list of property @@ -417,7 +417,7 @@ bool read_LAS_with_properties(std::istream& is, /** \ingroup PkgPointSetProcessing3IOLas - \brief Reads points (position only) from a .las or .laz stream. + \brief reads points (position only) from a .las or .laz stream. Potential additional properties are ignored. @@ -468,7 +468,7 @@ bool read_LAS(std::istream& is, /** \ingroup PkgPointSetProcessing3IOLas - \brief Reads points (position only) from a .las or .laz stream. + \brief reads points (position only) from a .las or .laz stream. Potential additional properties are ignored. @@ -572,7 +572,7 @@ bool read_LAS(const char* fname, OutputIterator output) /** \ingroup PkgPointSetProcessing3IOLas - \brief Reads points (position only) from a .las or .laz file. + \brief reads points (position only) from a .las or .laz file. Potential additional properties are ignored. diff --git a/Point_set_processing_3/include/CGAL/IO/read_off_points.h b/Point_set_processing_3/include/CGAL/IO/read_off_points.h index 027d707be63..222583230ef 100644 --- a/Point_set_processing_3/include/CGAL/IO/read_off_points.h +++ b/Point_set_processing_3/include/CGAL/IO/read_off_points.h @@ -42,7 +42,7 @@ namespace CGAL { /** \ingroup PkgPointSetProcessing3IOOff - \brief Reads points (positions + normals, if available) from a .off ASCII stream. + \brief reads points (positions + normals, if available) from a .off ASCII stream. The function expects for each point a line with the x y z position, optionally followed by the nx ny nz normal. @@ -200,7 +200,7 @@ bool read_OFF(std::istream& is, /** \ingroup PkgPointSetProcessing3IOOff - \brief Reads points (positions + normals, if available) from a .off ASCII file. + \brief reads points (positions + normals, if available) from a .off ASCII file. The function expects for each point a line with the x y z position, optionally followed by the nx ny nz normal. diff --git a/Point_set_processing_3/include/CGAL/IO/read_ply_points.h b/Point_set_processing_3/include/CGAL/IO/read_ply_points.h index df342f614d5..1553afa0669 100644 --- a/Point_set_processing_3/include/CGAL/IO/read_ply_points.h +++ b/Point_set_processing_3/include/CGAL/IO/read_ply_points.h @@ -102,7 +102,7 @@ make_ply_normal_reader(VectorMap normal_map); /** \ingroup PkgPointSetProcessingIOPly - \brief Reads user-selected points properties from a .ply stream (ASCII or binary). + \brief reads user-selected points properties from a .ply stream (ASCII or binary). Potential additional point properties and faces are ignored. @@ -193,7 +193,7 @@ bool read_PLY_with_properties(std::istream& is, /** \ingroup PkgPointSetProcessing3IOPly - \brief Reads points (positions + normals, if available) from a .ply stream (ASCII or binary). + \brief reads points (positions + normals, if available) from a .ply stream (ASCII or binary). Potential additional point properties and faces are ignored. @@ -267,7 +267,7 @@ bool read_PLY(std::istream& is, /** \ingroup PkgPointSetProcessing3IOPly - \brief Reads points (positions + normals, if available) from a .ply file (ASCII or binary). + \brief reads points (positions + normals, if available) from a .ply file (ASCII or binary). Potential additional point properties and faces are ignored. diff --git a/Point_set_processing_3/include/CGAL/IO/read_xyz_points.h b/Point_set_processing_3/include/CGAL/IO/read_xyz_points.h index 82c6fc412c3..a6baf22f42e 100644 --- a/Point_set_processing_3/include/CGAL/IO/read_xyz_points.h +++ b/Point_set_processing_3/include/CGAL/IO/read_xyz_points.h @@ -39,7 +39,7 @@ namespace CGAL { /** \ingroup PkgPointSetProcessing3IOXyz - \brief Reads points (positions + normals, if available) from a .xyz ASCII stream. + \brief reads points (positions + normals, if available) from a .xyz ASCII stream. The function expects for each point a line with the x y z position, optionally followed by the nx ny nz normal. @@ -187,7 +187,7 @@ bool read_XYZ(std::istream& is, /** \ingroup PkgPointSetProcessing3IOXyz - \brief Reads points (positions + normals, if available) from a .xyz ASCII file. + \brief reads points (positions + normals, if available) from a .xyz ASCII file. The function expects for each point a line with the x y z position, optionally followed by the nx ny nz normal. diff --git a/Point_set_processing_3/include/CGAL/IO/write_off_points.h b/Point_set_processing_3/include/CGAL/IO/write_off_points.h index 02137e47350..f2fe902e4f0 100644 --- a/Point_set_processing_3/include/CGAL/IO/write_off_points.h +++ b/Point_set_processing_3/include/CGAL/IO/write_off_points.h @@ -91,7 +91,7 @@ bool write_OFF_PSP(std::ostream& os, /** \ingroup PkgPointSetProcessing3IOOff - \brief Saves the range of `points` (positions + normals, if available) to a .off ASCII stream. + \brief saves the range of `points` (positions + normals, if available) to a .off ASCII stream. The function writes for each point a line with the x y z position followed by the nx ny nz normal (if available). @@ -159,7 +159,7 @@ bool write_OFF(std::ostream& os, const PointRange& points, /** \ingroup PkgPointSetProcessing3IOOff - \brief Saves the range of `points` (positions + normals, if available) to a .off ASCII stream. + \brief saves the range of `points` (positions + normals, if available) to a .off ASCII stream. The function writes for each point a line with the x y z position followed by the nx ny nz normal (if available). diff --git a/Point_set_processing_3/include/CGAL/IO/write_ply_points.h b/Point_set_processing_3/include/CGAL/IO/write_ply_points.h index 915297afb46..a690c29e886 100644 --- a/Point_set_processing_3/include/CGAL/IO/write_ply_points.h +++ b/Point_set_processing_3/include/CGAL/IO/write_ply_points.h @@ -78,7 +78,7 @@ namespace CGAL { /** \ingroup PkgPointSetProcessing3IOPly - \brief Saves the range of `points` with properties to a .ply stream. + \brief saves the range of `points` with properties to a .ply stream. %PLY is either ASCII or binary depending on the value of `CGAL::get_mode(os)`. @@ -140,7 +140,7 @@ template ::halfedge /// \ingroup PMP_locate_grp /// -/// \brief Returns a random point over the face `fd`, as a location. +/// \brief returns a random point over the face `fd`, as a location. /// /// \details The random point is on the face, meaning that all its barycentric coordinates /// are positive. It is constructed by uniformly picking a value `u` between `0` and `1`, @@ -459,7 +459,7 @@ random_location_on_face(typename boost::graph_traits::face_descrip /// \ingroup PMP_locate_grp /// -/// \brief Returns a random point over the mesh `tm`. +/// \brief returns a random point over the mesh `tm`. /// /// \details The returned location is obtained by choosing a random face of the mesh and /// a random point on that face. The barycentric coordinates of the point in the face @@ -919,7 +919,7 @@ is_on_mesh_border(const std::pair::fa /// \ingroup PMP_locate_grp /// -/// \brief Returns the location of the given vertex `vd` as a location, +/// \brief returns the location of the given vertex `vd` as a location, /// that is an ordered pair specifying a face incident to `vd` /// and the barycentric coordinates of the vertex `vd` in that face. /// @@ -981,7 +981,7 @@ locate_vertex(typename boost::graph_traits::vertex_descriptor vd, /// \ingroup PMP_locate_grp /// -/// \brief Returns the location of a given vertex as a location in `fd`, +/// \brief returns the location of a given vertex as a location in `fd`, /// that is an ordered pair composed of `fd` and of the barycentric coordinates /// of the vertex in `fd`. /// @@ -1828,7 +1828,7 @@ locate(const typename property_map_value::t /// \ingroup PMP_locate_grp /// -/// \brief Returns the face location along `ray` nearest to its source point. +/// \brief returns the face location along `ray` nearest to its source point. /// /// If the ray does not intersect the mesh, a default constructed location is returned. /// @@ -1969,7 +1969,7 @@ locate_with_AABB_tree(const typename internal::Location_traits::Ra /// \ingroup PMP_locate_grp /// -/// \brief Returns the face location along `ray` nearest to its source point. +/// \brief returns the face location along `ray` nearest to its source point. /// /// If the ray does not intersect the mesh, a default constructed location is returned. /// diff --git a/Polyhedron/demo/Polyhedron/Classification.cpp b/Polyhedron/demo/Polyhedron/Classification.cpp index aaa7d30116d..525a1ca1cfc 100644 --- a/Polyhedron/demo/Polyhedron/Classification.cpp +++ b/Polyhedron/demo/Polyhedron/Classification.cpp @@ -5,7 +5,7 @@ /*! - * \brief Defines the entry point of the demo. + * \brief defines the entry point of the demo. * Creates the application and sets a main window. */ int main(int argc, char **argv) diff --git a/Polyhedron/demo/Polyhedron/MainWindow.h b/Polyhedron/demo/Polyhedron/MainWindow.h index 8f681a3b3c8..b5bb55fbe55 100644 --- a/Polyhedron/demo/Polyhedron/MainWindow.h +++ b/Polyhedron/demo/Polyhedron/MainWindow.h @@ -87,7 +87,7 @@ public: @returns the IO plugin associated with `loader_name`*/ CGAL::Three::Polyhedron_demo_io_plugin_interface* findLoader(const QString& loader_name) const; - /*! \brief Loads on or more item with a given loader. + /*! \brief loads on or more item with a given loader. * * throws `std::logic_error` if loading does not succeed or * `std::invalid_argument` if `fileinfo` specifies an invalid file*/ @@ -379,7 +379,7 @@ protected: */ void loadPlugins(); /*! - * \brief Initializes the plugins. + * \brief initializes the plugins. * Makes pairs between plugins and object names and fills the Operations menu. * Called only once. */ diff --git a/Polyhedron/demo/Polyhedron/Mesh_3.cpp b/Polyhedron/demo/Polyhedron/Mesh_3.cpp index e29026b1ade..611139956e1 100644 --- a/Polyhedron/demo/Polyhedron/Mesh_3.cpp +++ b/Polyhedron/demo/Polyhedron/Mesh_3.cpp @@ -5,7 +5,7 @@ /*! - * \brief Defines the entry point of the demo. + * \brief defines the entry point of the demo. * Creates the application and sets a main window. */ int main(int argc, char **argv) diff --git a/Polyhedron/demo/Polyhedron/PMP.cpp b/Polyhedron/demo/Polyhedron/PMP.cpp index 469ff93b27d..3b3b4509f6e 100644 --- a/Polyhedron/demo/Polyhedron/PMP.cpp +++ b/Polyhedron/demo/Polyhedron/PMP.cpp @@ -5,7 +5,7 @@ /*! - * \brief Defines the entry point of the demo. + * \brief defines the entry point of the demo. * Creates the application and sets a main window. */ int main(int argc, char **argv) diff --git a/Polyhedron/demo/Polyhedron/Polyhedron_3.cpp b/Polyhedron/demo/Polyhedron/Polyhedron_3.cpp index f15675749d7..7376a475890 100644 --- a/Polyhedron/demo/Polyhedron/Polyhedron_3.cpp +++ b/Polyhedron/demo/Polyhedron/Polyhedron_3.cpp @@ -1,7 +1,7 @@ #include "Polyhedron_demo.h" /*! - * \brief Defines the entry point of the demo. + * \brief defines the entry point of the demo. * Creates the application and sets a main window. */ int main(int argc, char **argv) diff --git a/Polynomial/archive/include/CGAL/Polynomial/Wang_traits.h b/Polynomial/archive/include/CGAL/Polynomial/Wang_traits.h index e2d477a4978..2c4a633cc58 100644 --- a/Polynomial/archive/include/CGAL/Polynomial/Wang_traits.h +++ b/Polynomial/archive/include/CGAL/Polynomial/Wang_traits.h @@ -18,7 +18,7 @@ #include /*! \file CGAL/Polynomial/Wang_traits.h - * \brief Definition of traits class CGAL::Wang_traits. + * \brief definition of traits class CGAL::Wang_traits. */ namespace CGAL{ diff --git a/Polynomial/include/CGAL/Polynomial.h b/Polynomial/include/CGAL/Polynomial.h index 6fdfb42f422..b3681eb43b5 100644 --- a/Polynomial/include/CGAL/Polynomial.h +++ b/Polynomial/include/CGAL/Polynomial.h @@ -17,7 +17,7 @@ // they may be wrong now. /*! \file CGAL/Polynomial.h - * \brief Defines class CGAL::Polynomial. + * \brief defines class CGAL::Polynomial. * * Polynomials in one variable (or more, by recursion) */ diff --git a/Polynomial/include/CGAL/Polynomial/Polynomial_type.h b/Polynomial/include/CGAL/Polynomial/Polynomial_type.h index 540f17bd203..9f4316aa3eb 100644 --- a/Polynomial/include/CGAL/Polynomial/Polynomial_type.h +++ b/Polynomial/include/CGAL/Polynomial/Polynomial_type.h @@ -17,7 +17,7 @@ // they may be wrong now. /*! \file CGAL/Polynomial.h - * \brief Defines class CGAL::Polynomial. + * \brief defines class CGAL::Polynomial. * * Polynomials in one variable (or more, by recursion) */ @@ -538,7 +538,7 @@ public: y+=abs(pow(x,d)*to_Interval(this->ptr()->coeff[d])); return y; } */ - /*! \brief return the sign of the leading coefficient + /*! \brief returns the sign of the leading coefficient * * For univariate real polynomials, this is the sign * of the limit process \e x --> oo. diff --git a/Polynomial/include/CGAL/Polynomial/modular_filter.h b/Polynomial/include/CGAL/Polynomial/modular_filter.h index 434df59decc..66c10eaf9f8 100644 --- a/Polynomial/include/CGAL/Polynomial/modular_filter.h +++ b/Polynomial/include/CGAL/Polynomial/modular_filter.h @@ -83,7 +83,7 @@ namespace internal { ::CGAL::Tag_false) {return true;} /*! \ingroup CGAL_polynomial_utils - * \brief Test whether \c P and \c Q may have a common factor. + * \brief tests whether \c P and \c Q may have a common factor. * * This function is based on a fast modular arithmetic and serves as a * filter to avoid expensive exact computations to determine whether \c P @@ -110,7 +110,7 @@ bool may_have_common_factor(const Polynomial& P, } /*! \ingroup CGAL_polynomial_utils - * \brief Test whether the polynomial \c P may has a multiple root. + * \brief tests whether the polynomial \c P may has a multiple root. * * This function is based on a fast modular arithmetic and serves as a * filter to avoid expensive exact computations to determine whether \c P diff --git a/Polynomial/include/CGAL/Polynomial/modular_gcd_utils.h b/Polynomial/include/CGAL/Polynomial/modular_gcd_utils.h index e20c4f6e33d..0fc6bc696b4 100644 --- a/Polynomial/include/CGAL/Polynomial/modular_gcd_utils.h +++ b/Polynomial/include/CGAL/Polynomial/modular_gcd_utils.h @@ -13,7 +13,7 @@ // ============================================================================ /*! \file CGAL/Polynomial/modular_gcd_utils.h - * \brief Provides additional utils for the modular GCD calculation + * \brief provides additional utils for the modular GCD calculation */ #ifndef CGAL_POLYNOMIAL_MODULAR_GCD_UTILS_H diff --git a/Polynomial/include/CGAL/Polynomial/polynomial_gcd.h b/Polynomial/include/CGAL/Polynomial/polynomial_gcd.h index aeda5517bd7..069d4cc80b9 100644 --- a/Polynomial/include/CGAL/Polynomial/polynomial_gcd.h +++ b/Polynomial/include/CGAL/Polynomial/polynomial_gcd.h @@ -102,7 +102,7 @@ Polynomial gcd_( // name gcd() forwarded to the internal::gcd_() dispatch function /*! \ingroup CGAL_Polynomial * \relates CGAL::Polynomial - * \brief return the greatest common divisor of \c p1 and \c p2 + * \brief returns the greatest common divisor of \c p1 and \c p2 * * \pre Requires \c Innermost_coefficient_type to be a \c Field or a \c UFDomain. */ diff --git a/STL_Extension/include/CGAL/Cache.h b/STL_Extension/include/CGAL/Cache.h index 9b519c1764e..30204959ebc 100644 --- a/STL_Extension/include/CGAL/Cache.h +++ b/STL_Extension/include/CGAL/Cache.h @@ -87,7 +87,7 @@ public: //! default constructor with empty table Cache() : map() {}; - /*! \brief Returns the respective object of type Output. + /*! \brief returns the respective object of type Output. * * If the object is not in the cache, it is constructed form \c key and * added to the cache. @@ -130,22 +130,22 @@ public: //! Returns a Const_iterator pointing to the end of the cache. Const_iterator end() const { return map.end(); } - /*! \brief Returns a Reverse_iterator pointing to the beginning of the + /*! \brief returns a Reverse_iterator pointing to the beginning of the * reversed cache. */ Reverse_iterator rbegin() { return map.rbegin(); } - /*! \brief Returns a Reverse_iterator pointing to the end of the reversed + /*! \brief returns a Reverse_iterator pointing to the end of the reversed * cache. */ Reverse_iterator rend() { return map.rend(); } - /*! \brief Returns a Const_reverse_iterator pointing to the beginning of + /*! \brief returns a Const_reverse_iterator pointing to the beginning of * the reversed cache. */ Const_reverse_iterator rbegin() const { return map.rbegin(); } - /*! \brief Returns a Const_reverse_iterator pointing to the end of the + /*! \brief returns a Const_reverse_iterator pointing to the end of the * reversed cache. */ Const_reverse_iterator rend() const { return map.rend(); } diff --git a/Stream_support/include/CGAL/IO/3MF.h b/Stream_support/include/CGAL/IO/3MF.h index 29475ef97ac..e7108cfbb78 100644 --- a/Stream_support/include/CGAL/IO/3MF.h +++ b/Stream_support/include/CGAL/IO/3MF.h @@ -374,7 +374,7 @@ int read_from_3mf(const std::string& fname, /*! * \ingroup PkgStreamSupportIoFuncs3MF * - * \brief Extracts ranges of points and triangles from a 3mf file. + * \brief extracts ranges of points and triangles from a 3mf file. * * \tparam PointRanges a model of the concepts `RandomAccessContainer` and * `BackInsertionSequence` whose `value type` is @@ -425,7 +425,7 @@ int read_triangle_soups_from_3mf(const std::string& fname, /*! * \ingroup PkgStreamSupportIoFuncs3MF * - * \brief Writes the triangle soups contained in `all_points` and + * \brief writes the triangle soups contained in `all_points` and * `all_polygons` into the 3mf file `fname`. * * \tparam PointRanges a model of the concepts `RandomAccessContainer` and diff --git a/Stream_support/include/CGAL/IO/GOCAD.h b/Stream_support/include/CGAL/IO/GOCAD.h index f7e589822d5..aadfb8e2329 100644 --- a/Stream_support/include/CGAL/IO/GOCAD.h +++ b/Stream_support/include/CGAL/IO/GOCAD.h @@ -184,7 +184,7 @@ bool read_GOCAD(const std::string& fname, /*! * \ingroup PkgStreamSupportIoFuncsGOCAD * - * \brief Reads the content of `is` into `points` and `polygons`, using the \ref IOStreamGocad. + * \brief reads the content of `is` into `points` and `polygons`, using the \ref IOStreamGocad. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` @@ -208,7 +208,7 @@ bool read_GOCAD(std::istream& is, PointRange& points, PolygonRange& polygons) /*! * \ingroup PkgStreamSupportIoFuncsGOCAD * - * \brief Reads the content of the file `fname` into `points` and `polygons`, using the \ref IOStreamGocad. + * \brief reads the content of the file `fname` into `points` and `polygons`, using the \ref IOStreamGocad. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` @@ -326,7 +326,7 @@ bool write_GOCAD(const char* fname, /*! * \ingroup PkgStreamSupportIoFuncsGOCAD * - * \brief Writes the content of `points` and `polygons` in `os`, using the \ref IOStreamGocad. + * \brief writes the content of `points` and `polygons` in `os`, using the \ref IOStreamGocad. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` @@ -349,7 +349,7 @@ bool write_GOCAD(std::ostream& os, const PointRange& points, const PolygonRange& /*! * \ingroup PkgStreamSupportIoFuncsGOCAD * - * \brief Writes the content of `points` and `polygons` in `fname`, using the \ref IOStreamGocad. + * \brief writes the content of `points` and `polygons` in `fname`, using the \ref IOStreamGocad. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` diff --git a/Stream_support/include/CGAL/IO/OBJ.h b/Stream_support/include/CGAL/IO/OBJ.h index 913a55d64f7..5a5fa2ff92d 100644 --- a/Stream_support/include/CGAL/IO/OBJ.h +++ b/Stream_support/include/CGAL/IO/OBJ.h @@ -209,7 +209,7 @@ bool read_OBJ(const std::string& fname, PointRange& points, PolygonRange& polygo /// \ingroup PkgStreamSupportIoFuncsOBJ /// -/// \brief Reads the content of `is` into `points` and `polygons`, using the \ref IOStreamOBJ. +/// \brief reads the content of `is` into `points` and `polygons`, using the \ref IOStreamOBJ. /// /// \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. /// \tparam PolygonRange a model of the concept `SequenceContainer` @@ -230,7 +230,7 @@ bool read_OBJ(std::istream& is, PointRange& points, PolygonRange& polygons) /// \ingroup PkgStreamSupportIoFuncsOBJ /// -/// \brief Reads the content of the file `fname` into `points` and `polygons`, using the \ref IOStreamOBJ. +/// \brief reads the content of the file `fname` into `points` and `polygons`, using the \ref IOStreamOBJ. /// /// \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. /// \tparam PolygonRange a model of the concept `SequenceContainer` @@ -294,7 +294,7 @@ bool write_OBJ(const std::string& fname, const PointRange& points, const Polygon /*! * \ingroup PkgStreamSupportIoFuncsOBJ * - * \brief Writes the content of `points` and `polygons` in `os`, using the \ref IOStreamOBJ. + * \brief writes the content of `points` and `polygons` in `os`, using the \ref IOStreamOBJ. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` @@ -317,7 +317,7 @@ bool write_OBJ(std::ostream& os, const PointRange& points, const PolygonRange& p /*! * \ingroup PkgStreamSupportIoFuncsOBJ * - * \brief Writes the content of `points` and `polygons` in a file named `fname`, using the \ref IOStreamOBJ. + * \brief writes the content of `points` and `polygons` in a file named `fname`, using the \ref IOStreamOBJ. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` diff --git a/Stream_support/include/CGAL/IO/OFF.h b/Stream_support/include/CGAL/IO/OFF.h index 6a988791316..0fb76d074ff 100644 --- a/Stream_support/include/CGAL/IO/OFF.h +++ b/Stream_support/include/CGAL/IO/OFF.h @@ -202,7 +202,7 @@ bool read_OFF(const std::string& fname, PointRange& points, PolygonRange& polygo /*! * \ingroup PkgStreamSupportIoFuncsOFF * - * \brief Reads the content of `is` into `points` and `polygons`, using the \ref IOStreamOFF. + * \brief reads the content of `is` into `points` and `polygons`, using the \ref IOStreamOFF. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` @@ -225,7 +225,7 @@ bool read_OFF(std::istream& is, PointRange& points, PolygonRange& polygons) /*! * \ingroup PkgStreamSupportIoFuncsOFF * - * \brief Reads the content of the file `fname` into `points` and `polygons`, using the \ref IOStreamOFF. + * \brief reads the content of the file `fname` into `points` and `polygons`, using the \ref IOStreamOFF. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` @@ -279,7 +279,7 @@ bool write_OFF(const char* fname, /*! * \ingroup PkgStreamSupportIoFuncsOFF * - * \brief Writes the content of `points` and `polygons` in `os`, using the \ref IOStreamOFF. + * \brief writes the content of `points` and `polygons` in `os`, using the \ref IOStreamOFF. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` @@ -306,7 +306,7 @@ bool write_OFF(std::ostream& os, const PointRange& points, const PolygonRange& p /*! * \ingroup PkgStreamSupportIoFuncsOFF * - * \brief Writes the content of `points` and `polygons` in the file `fname`, using the \ref IOStreamOFF. + * \brief writes the content of `points` and `polygons` in the file `fname`, using the \ref IOStreamOFF. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` diff --git a/Stream_support/include/CGAL/IO/PLY.h b/Stream_support/include/CGAL/IO/PLY.h index 9b195768dd7..e5320fd0444 100644 --- a/Stream_support/include/CGAL/IO/PLY.h +++ b/Stream_support/include/CGAL/IO/PLY.h @@ -253,7 +253,7 @@ bool read_PLY(std::istream& is, /*! * \ingroup PkgStreamSupportIoFuncsPLY * - * \brief Reads the content of `is` into `points` and `polygons`, using the \ref IOStreamPLY. + * \brief reads the content of `is` into `points` and `polygons`, using the \ref IOStreamPLY. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` @@ -306,7 +306,7 @@ bool read_PLY(std::istream& is, PointRange& points, PolygonRange& polygons, /*! * \ingroup PkgStreamSupportIoFuncsPLY * - * \brief Reads the content of `fname` into `points` and `polygons`, using the \ref IOStreamPLY. + * \brief reads the content of `fname` into `points` and `polygons`, using the \ref IOStreamPLY. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` @@ -468,7 +468,7 @@ bool write_PLY(std::ostream& out, const PointRange& points, const PolygonRange& /*! * \ingroup PkgStreamSupportIoFuncsPLY * - * \brief Writes the content of `points` and `polygons` in the file `fname`, using the \ref IOStreamPLY. + * \brief writes the content of `points` and `polygons` in the file `fname`, using the \ref IOStreamPLY. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` diff --git a/Stream_support/include/CGAL/IO/STL.h b/Stream_support/include/CGAL/IO/STL.h index 5c99eefa3e8..ed46925b4f3 100644 --- a/Stream_support/include/CGAL/IO/STL.h +++ b/Stream_support/include/CGAL/IO/STL.h @@ -125,7 +125,7 @@ bool read_STL(std::istream& is, /*! * \ingroup PkgStreamSupportIoFuncsSTL * - * \brief Reads the content of `is` into `points` and `facets`, using the \ref IOStreamSTL. + * \brief reads the content of `is` into `points` and `facets`, using the \ref IOStreamSTL. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` @@ -162,7 +162,7 @@ bool read_STL(const std::string& fname, PointRange& points, TriangleRange& facet /*! * \ingroup PkgStreamSupportIoFuncsSTL * - * \brief Reads the content of a file named `fname` into `points` and `polygons`, using the \ref IOStreamSTL. + * \brief reads the content of a file named `fname` into `points` and `polygons`, using the \ref IOStreamSTL. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` @@ -297,7 +297,7 @@ bool write_STL(const char* fname, const PointRange& points, const TriangleRange& /*! * \ingroup PkgStreamSupportIoFuncsSTL * - * \brief Writes the content of `points` and `polygons` in a file named `fname`, using the \ref IOStreamSTL. + * \brief writes the content of `points` and `polygons` in a file named `fname`, using the \ref IOStreamSTL. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` diff --git a/Stream_support/include/CGAL/IO/VTK.h b/Stream_support/include/CGAL/IO/VTK.h index 75ffcd70b78..648d50c3089 100644 --- a/Stream_support/include/CGAL/IO/VTK.h +++ b/Stream_support/include/CGAL/IO/VTK.h @@ -134,7 +134,7 @@ bool read_VTP(const std::string& fname, /*! * \ingroup PkgStreamSupportIoFuncsVTP * - * \brief Reads the content of `is` into `points` and `polygons`, using the \ref IOStreamVTK. + * \brief reads the content of `is` into `points` and `polygons`, using the \ref IOStreamVTK. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` @@ -368,7 +368,7 @@ void write_soup_polys_points(std::ostream& os, /*! * \ingroup PkgStreamSupportIoFuncsVTP * - * \brief Writes the content of `points` and `polygons` in `out`, using the \ref IOStreamVTK. + * \brief writes the content of `points` and `polygons` in `out`, using the \ref IOStreamVTK. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` @@ -469,7 +469,7 @@ bool write_VTP(std::ostream& os, /*! * \ingroup PkgStreamSupportIoFuncsVTP * - * \brief Writes the content of `points` and `polygons` in a file named `fname`, using the \ref IOStreamVTK. + * \brief writes the content of `points` and `polygons` in a file named `fname`, using the \ref IOStreamVTK. * * \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type. * \tparam PolygonRange a model of the concept `SequenceContainer` diff --git a/Stream_support/include/CGAL/IO/WKT.h b/Stream_support/include/CGAL/IO/WKT.h index f6353101009..576e82ee06d 100644 --- a/Stream_support/include/CGAL/IO/WKT.h +++ b/Stream_support/include/CGAL/IO/WKT.h @@ -62,7 +62,7 @@ void pop_back_if_equal_to_front(CGAL::Polygon_with_holes_2& pwh) //! \ingroup PkgStreamSupportIoFuncsWKT //! -//! \brief Fills a `Point` from a WKT stream. +//! \brief fills a `Point` from a WKT stream. //! //! The first line starting with POINT in the stream will be used. //! @@ -111,7 +111,7 @@ bool read_point_WKT(std::istream& in, //! \ingroup PkgStreamSupportIoFuncsWKT //! -//! \brief Overwrites the content of a `MultiPoint` with the first line starting with MULTIPOINT in the stream. +//! \brief overwrites the content of a `MultiPoint` with the first line starting with MULTIPOINT in the stream. //! //! \tparam MultiPoint must be a model of `RandomAccessRange` of `CGAL::Point_2` or `CGAL::Point_3`, //! and have: @@ -159,7 +159,7 @@ bool read_multi_point_WKT(std::istream& in, //! \ingroup PkgStreamSupportIoFuncsWKT //! -//! \brief Fills a `Linestring` from a WKT stream. +//! \brief fills a `Linestring` from a WKT stream. //! //! The first line starting with LINESTRING in the stream will be used. //! @@ -208,7 +208,7 @@ bool read_linestring_WKT(std::istream& in, //! \ingroup PkgStreamSupportIoFuncsWKT //! -//! \brief Overwrites the content of a `MultiLineString` with the first line starting with MULTILINESTRING in the stream. +//! \brief overwrites the content of a `MultiLineString` with the first line starting with MULTILINESTRING in the stream. //! //! \tparam MultiLineString must be a model of `RandomAccessRange` of `Linestring`, //! and have: @@ -267,7 +267,7 @@ bool read_multi_linestring_WKT(std::istream& in, //! \ingroup PkgStreamSupportIoFuncsWKT //! -//! \brief Fills `polygon` from a WKT stream. +//! \brief fills `polygon` from a WKT stream. //! //! The first line starting with POLYGON in the stream will be used. //! @@ -315,7 +315,7 @@ bool read_polygon_WKT(std::istream& in, //! \ingroup PkgStreamSupportIoFuncsWKT //! -//! \brief Overwrites the content of a `MultiPolygon` with the first line starting with MULTIPOLYGON in the stream. +//! \brief overwrites the content of a `MultiPolygon` with the first line starting with MULTIPOLYGON in the stream. //! //! \tparam MultiPolygon must be a model of `RandomAccessRange` of `CGAL::General_polygon_with_holes_2`, //! and have: @@ -370,7 +370,7 @@ bool read_multi_polygon_WKT(std::istream& in, //! \ingroup PkgStreamSupportIoFuncsWKT //! -//! \brief Writes `point` into a WKT stream. +//! \brief writes `point` into a WKT stream. //! //! \tparam Point is a `CGAL::Point_2` //! @@ -394,7 +394,7 @@ std::ostream& write_point_WKT(std::ostream& out, //! \ingroup PkgStreamSupportIoFuncsWKT //! -//! \brief Writes `poly` into a WKT stream. +//! \brief writes `poly` into a WKT stream. //! //! \tparam Polygon must be a `CGAL::General_polygon_with_holes_2` //! @@ -418,7 +418,7 @@ std::ostream& write_polygon_WKT(std::ostream& out, //! \ingroup PkgStreamSupportIoFuncsWKT //! -//! \brief Writes the content of `ls` into a WKT stream. +//! \brief writes the content of `ls` into a WKT stream. //! //! \tparam LineString must be a `RandomAccessRange` of `CGAL::Point_2`. //! @@ -443,7 +443,7 @@ std::ostream& write_linestring_WKT(std::ostream& out, //! \ingroup PkgStreamSupportIoFuncsWKT //! -//! \brief Writes the content of `mp` into a WKT stream. +//! \brief writes the content of `mp` into a WKT stream. //! //! \tparam MultiPoint must be a `RandomAccessRange` of `CGAL::Point_2`. //! @@ -468,7 +468,7 @@ std::ostream& write_multi_point_WKT(std::ostream& out, //! \ingroup PkgStreamSupportIoFuncsWKT //! -//! \brief Writes the content of `polygons` into a WKT stream. +//! \brief writes the content of `polygons` into a WKT stream. //! //! \tparam MultiPolygon must be a `RandomAccessRange` of `CGAL::General_polygon_with_holes_2`. //! @@ -493,7 +493,7 @@ std::ostream& write_multi_polygon_WKT(std::ostream& out, //! \ingroup PkgStreamSupportIoFuncsWKT //! -//! \brief Writes the content of `mls` into a WKT stream. +//! \brief writes the content of `mls` into a WKT stream. //! //! \tparam MultiLineString must be a `RandomAccessRange` of `LineString`. //! diff --git a/Stream_support/include/CGAL/IO/polygon_soup_io.h b/Stream_support/include/CGAL/IO/polygon_soup_io.h index da35125408d..f6247f75d30 100644 --- a/Stream_support/include/CGAL/IO/polygon_soup_io.h +++ b/Stream_support/include/CGAL/IO/polygon_soup_io.h @@ -36,7 +36,7 @@ namespace CGAL { /*! * \ingroup IOstreamFunctions * - * \brief Reads a polygon soup from a file. + * \brief reads a polygon soup from a file. * * Supported file formats are the following: * - \ref IOStreamOFF (`.off`) @@ -101,7 +101,7 @@ bool read_polygon_soup(const std::string& fname, /*! * \ingroup IOstreamFunctions * - * \brief Writes the content of `points` and `polygons` in a file. + * \brief writes the content of `points` and `polygons` in a file. * * Supported file formats are the following: * - \ref IOStreamOFF (`.off`) diff --git a/Surface_mesh/include/CGAL/Surface_mesh/IO/3MF.h b/Surface_mesh/include/CGAL/Surface_mesh/IO/3MF.h index fdb5e7b075f..9839411b611 100644 --- a/Surface_mesh/include/CGAL/Surface_mesh/IO/3MF.h +++ b/Surface_mesh/include/CGAL/Surface_mesh/IO/3MF.h @@ -31,7 +31,7 @@ namespace CGAL { /*! * \ingroup PkgSurfaceMeshIOFunc * - * \brief Extracts the surface meshes from an input 3mf file and appends it to `output`. + * \brief extracts the surface meshes from an input 3mf file and appends it to `output`. * * \tparam Point The type of the \em point property of a vertex. There is no requirement on `P`, * besides being default constructible and assignable. diff --git a/Surface_mesh/include/CGAL/Surface_mesh/IO/OFF.h b/Surface_mesh/include/CGAL/Surface_mesh/IO/OFF.h index 6e8d2bb1e74..82752a18096 100644 --- a/Surface_mesh/include/CGAL/Surface_mesh/IO/OFF.h +++ b/Surface_mesh/include/CGAL/Surface_mesh/IO/OFF.h @@ -257,7 +257,7 @@ bool read_OFF_with_or_without_vnormals(std::istream& is, /// \ingroup PkgSurfaceMeshIOFunc /// -/// \brief Extracts the surface mesh from an input stream in ASCII OFF, COFF, NOFF, CNOFF +/// \brief extracts the surface mesh from an input stream in ASCII OFF, COFF, NOFF, CNOFF /// format and appends it to the surface mesh `sm`. /// /// The operator reads the point property as well as "v:normal", "v:color", `"v:texcoord"`, and "f:color". @@ -493,7 +493,7 @@ bool write_OFF_with_or_without_vnormals(std::ostream& os, /// \ingroup PkgSurfaceMeshIOFunc /// -/// \brief Writes the surface mesh `sm` in the output stream, using the \ref IOStreamOFF. +/// \brief writes the surface mesh `sm` in the output stream, using the \ref IOStreamOFF. /// /// This overload of \link PkgBGLIOFct `read_OFF(std::ostream&, const Graph&)` \endlink will also output /// the following property maps internal to the surface mesh, if they exist and if they are not diff --git a/Surface_mesh/include/CGAL/Surface_mesh/IO/PLY.h b/Surface_mesh/include/CGAL/Surface_mesh/IO/PLY.h index ae8e67105e4..aa07e79016d 100644 --- a/Surface_mesh/include/CGAL/Surface_mesh/IO/PLY.h +++ b/Surface_mesh/include/CGAL/Surface_mesh/IO/PLY.h @@ -713,7 +713,7 @@ void fill_header(std::ostream& os, const Surface_mesh& sm, /// \ingroup PkgSurfaceMeshIOFunc /// -/// \brief Extracts the surface mesh from an input stream in ASCII or Binary PLY format +/// \brief extracts the surface mesh from an input stream in ASCII or Binary PLY format /// and appends it to the surface mesh `sm`. /// /// - the operator reads the vertex `point` property and the face @@ -866,7 +866,7 @@ CGAL_DEPRECATED bool read_ply(std::istream& is, Surface_mesh

& sm, std::string /// \ingroup PkgSurfaceMeshIOFunc /// -/// \brief Inserts the surface mesh in an output stream in PLY format. +/// \brief inserts the surface mesh in an output stream in PLY format. /// /// If found, internal property maps with names "v:normal", "v:color" and "f:color" are inserted in the stream. /// diff --git a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Error_code.h b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Error_code.h index d5d19889147..55305e2c4c3 100644 --- a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Error_code.h +++ b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Error_code.h @@ -38,7 +38,7 @@ enum Error_code }; /// \ingroup PkgSurfaceMeshParameterizationEnums -/// \brief Get the message corresponding to an error code. +/// \brief gets the message corresponding to an error code. /// \param error_code The code returned by `parameterize()` /// \return The string describing the error code. inline const char* get_error_message(int error_code) diff --git a/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path/Surface_mesh_shortest_path.h b/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path/Surface_mesh_shortest_path.h index 6d24ecfcab3..d2356fe22b0 100644 --- a/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path/Surface_mesh_shortest_path.h +++ b/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path/Surface_mesh_shortest_path.h @@ -2192,7 +2192,7 @@ public: /// @{ /*! - \brief Creates a shortest paths object using `tm` as input. + \brief creates a shortest paths object using `tm` as input. Equivalent to `Surface_mesh_shortest_path(tm, get(boost::vertex_index, tm), get(boost::halfedge_index, tm), get(boost::face_index, tm), get(CGAL::vertex_point, tm), traits)`. @@ -2215,7 +2215,7 @@ public: } /*! - \brief Creates a shortest paths object using `tm` as input. + \brief creates a shortest paths object using `tm` as input. \details No copy of the `Triangle_mesh` is made, only a reference to the `tm` is held. @@ -2271,7 +2271,7 @@ public: /// @{ /*! - \brief Adds `v` as a source for the shortest path queries. + \brief adds `v` as a source for the shortest path queries. \details No change to the internal shortest paths data structure occurs until either `Surface_mesh_shortest_path::build_sequence_tree()` or @@ -2286,7 +2286,7 @@ public: } /*! - \brief Adds a point inside the face `f` as a source for the shortest path queries. + \brief adds a point inside the face `f` as a source for the shortest path queries. \details No change to the internal shortest paths data structure occurs until either `Surface_mesh_shortest_path::build_sequence_tree()` or @@ -2303,7 +2303,7 @@ public: } /*! - \brief Adds a point inside a face as a source for the shortest path queries, + \brief adds a point inside a face as a source for the shortest path queries, equivalent to `Surface_mesh_shortest_path::add_source_point(location.first, location.second);` */ Source_point_iterator add_source_point(const Face_location& location) @@ -2319,7 +2319,7 @@ public: } /*! - \brief Adds a range of points as sources for the shortest path queries. + \brief adds a range of points as sources for the shortest path queries. \details No change to the internal shortest paths data structure occurs until either `Surface_mesh_shortest_path::build_sequence_tree()` or @@ -2339,7 +2339,7 @@ public: } /*! - \brief Removes a source point for the shortest path queries. + \brief removes a source point for the shortest path queries. \details No change to the internal shortest paths data structure occurs until either `Surface_mesh_shortest_path::build_sequence_tree()` or @@ -2359,7 +2359,7 @@ public: } /*! - \brief Removes all source points for the shortest path queries. + \brief removes all source points for the shortest path queries. \details No change to the internal shortest paths data structure occurs until either `Surface_mesh_shortest_path::build_sequence_tree()` or @@ -2394,7 +2394,7 @@ public: } /*! - \brief Removes all data, the class is as if it was constructed. + \brief removes all data, the class is as if it was constructed. \details All internal containers are cleared and the internal sequence tree is also cleared. For a version which defers deletion until @@ -2411,7 +2411,7 @@ public: /// @{ /*! - \brief Returns an iterator to the first source point location + \brief returns an iterator to the first source point location \details The elements will appear in the order they were inserted to the structure by calls to `add_source_point()` or `add_source_points()`. Deleted @@ -2428,7 +2428,7 @@ public: } /*! - \brief Returns an iterator to one past the last source point location + \brief returns an iterator to one past the last source point location \return An iterator to one past-the-end in the list of stored source points. */ @@ -2438,7 +2438,7 @@ public: } /*! - \brief Returns the total number of source points used for the shortest path queries. + \brief returns the total number of source points used for the shortest path queries. */ std::size_t number_of_source_points() const { @@ -2446,7 +2446,7 @@ public: } /*! - \brief Determines if the internal sequence tree is valid (already built and no new source point has been added). + \brief determines if the internal sequence tree is valid (already built and no new source point has been added). \return true if the structure needs to be rebuilt, false otherwise */ @@ -2522,7 +2522,7 @@ public: /// @{ /*! - \brief Visits the sequence of edges, vertices and faces traversed by the shortest path + \brief visits the sequence of edges, vertices and faces traversed by the shortest path from a vertex to any source point. \details Visits simplices, starting from the query vertex, back to @@ -2560,7 +2560,7 @@ public: } /*! - \brief Visits the sequence of edges, vertices and faces traversed by the shortest path + \brief visits the sequence of edges, vertices and faces traversed by the shortest path from any surface location to any source point. \details Visits simplices, starting from the query point, back to @@ -2657,7 +2657,7 @@ public: /// @{ /*! - \brief Returns the 3-dimensional coordinates at the barycentric coordinates + \brief returns the 3-dimensional coordinates at the barycentric coordinates of the given face. \details The following static overloads are also available: @@ -2698,7 +2698,7 @@ public: /// \endcond /*! - \brief Returns the 3-dimensional coordinates at the parametric location + \brief returns the 3-dimensional coordinates at the parametric location along the given edge. \details The following static overloads are also available: @@ -2737,7 +2737,7 @@ public: /// \endcond /*! - \brief Returns the 3-dimensional coordinates of the given vertex. + \brief returns the 3-dimensional coordinates of the given vertex. \param vertex A vertex of the input face graph */ @@ -2752,7 +2752,7 @@ public: /// @{ /*! - \brief Returns the location of the given vertex as a `Face_location` + \brief returns the location of the given vertex as a `Face_location` \details The following static overload is also available: - `static Face_location face_location(vertex_descriptor vertex, const Triangle_mesh& tm, const Traits& traits = Traits())` @@ -2789,7 +2789,7 @@ public: /// \endcond /*! - \brief Returns a location along the given edge as a `Face_location`. + \brief returns a location along the given edge as a `Face_location`. \details The following static overload is also available: - `static Face_location face_location(halfedge_descriptor he, FT t, const Triangle_mesh& tm, const Traits& traits = Traits())` @@ -2830,7 +2830,7 @@ public: /// @{ /*! - \brief Returns the nearest face location to the given point. + \brief returns the nearest face location to the given point. Note that this will (re-)build an `AABB_tree` on each call. If you need to call this function more than once, use `build_aabb_tree()` to cache a copy of the `AABB_tree`, and use the overloads of this function @@ -2865,7 +2865,7 @@ public: /// \endcond /*! - \brief Returns the face location nearest to the given point. + \brief returns the face location nearest to the given point. \details The following static overload is also available: - static Face_location locate(const %Point_3& p, const AABB_tree& tree, const Triangle_mesh& tm, Vertex_point_map vertexPointMap, const Traits& traits = Traits()) @@ -2902,7 +2902,7 @@ public: /// \endcond /*! - \brief Returns the face location along `ray` nearest to its source point. + \brief returns the face location along `ray` nearest to its source point. Note that this will (re-)build an `AABB_tree` on each call. If you need to call this function more than once, use `build_aabb_tree()` to cache a copy of the `AABB_tree`, and use the overloads of this function @@ -2937,7 +2937,7 @@ public: /// \endcond /*! - \brief Returns the face location along `ray` nearest to + \brief returns the face location along `ray` nearest to its source point. \details The following static overload is also available: @@ -3015,7 +3015,7 @@ public: /// \endcond /*! - \brief Creates an `AABB_tree` suitable for use with `locate`. + \brief creates an `AABB_tree` suitable for use with `locate`. \details The following static overload is also available: - `static void build_aabb_tree(const Triangle_mesh& tm, AABB_tree& outTree)` diff --git a/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path/Surface_mesh_shortest_path_traits.h b/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path/Surface_mesh_shortest_path_traits.h index 346574b6c9a..8a67d99a1d2 100644 --- a/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path/Surface_mesh_shortest_path_traits.h +++ b/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path/Surface_mesh_shortest_path_traits.h @@ -171,7 +171,7 @@ std::ostream& operator<<(std::ostream& os, typename Surface_mesh_shortest_path_t \internal -\brief Provides an implementation of the SurfaceMeshShortestPathTraits +\brief provides an implementation of the SurfaceMeshShortestPathTraits model which uses an exact Kernel during the unfolding operations to achieve better overall precision \tparam K Kernel Type diff --git a/Three/include/CGAL/Three/Buffer_objects.h b/Three/include/CGAL/Three/Buffer_objects.h index 0f9df13825b..2fd3575832c 100644 --- a/Three/include/CGAL/Three/Buffer_objects.h +++ b/Three/include/CGAL/Three/Buffer_objects.h @@ -35,7 +35,7 @@ struct Vao{ QOpenGLShaderProgram* program; std::vector vbos; //! - //! \brief Creates a `Vao`. + //! \brief creates a `Vao`. //! \param program the `QOpenGLShaderProgram` associated with this `Vao`. //! \attention This must be called within a valid OpenGLContext. //! Most of the time, initGL() functions are safe places to do so. @@ -48,7 +48,7 @@ struct Vao{ } //! - //! \brief Creates a `Vao` from another one. + //! \brief creates a `Vao` from another one. //! \param program the `QOpenGLShaderProgram` corresponding to the one of `vao` but from //! the right viewer. //! \param vao the Vao to copy. @@ -117,7 +117,7 @@ struct Vbo int stride; bool allocated; //! - //! \brief Creates a `Vbo`. + //! \brief creates a `Vbo`. //! \param attribute the name of the corresponding data in the shader. //! \param flag the flag that specifies which type of data this corresponds to. //! \param vbo_type is almost always `QOpenGLBuffer::VertexBuffer` but can be `QOpenGLBuffer::IndexBuffer` diff --git a/Three/include/CGAL/Three/Polyhedron_demo_io_plugin_interface.h b/Three/include/CGAL/Three/Polyhedron_demo_io_plugin_interface.h index 44296a50651..fe0e253000d 100644 --- a/Three/include/CGAL/Three/Polyhedron_demo_io_plugin_interface.h +++ b/Three/include/CGAL/Three/Polyhedron_demo_io_plugin_interface.h @@ -31,7 +31,7 @@ class Scene_interface; class Polyhedron_demo_io_plugin_interface { public: - //! \brief Initializes the plugin + //! \brief initializes the plugin //! This function is called in the constructor of the MainWindow. //! Whatever initialization the plugin needs can be done here. Default //! behavior is to do nothing. diff --git a/Three/include/CGAL/Three/Polyhedron_demo_plugin_helper.h b/Three/include/CGAL/Three/Polyhedron_demo_plugin_helper.h index abc731d9ccb..dd04a031e81 100644 --- a/Three/include/CGAL/Three/Polyhedron_demo_plugin_helper.h +++ b/Three/include/CGAL/Three/Polyhedron_demo_plugin_helper.h @@ -32,7 +32,7 @@ class QDockWidget; #include namespace CGAL { namespace Three { - /*! \brief Provides convenient functions for a plugin. + /*! \brief provides convenient functions for a plugin. * This class provides convenient functions to manage dock_widgets and to access a certain type of items in the scene. * It also provides member variables for a Scene_interface and a QMainWindow. */ @@ -41,7 +41,7 @@ class SCENE_ITEM_EXPORT Polyhedron_demo_plugin_helper { public: - /*! \brief Gets an item of the templated type. + /*! \brief gets an item of the templated type. * \returns The currently selected `SceneType` item * \returns the first `SceneType` item found in the scene's list of items if the selected item is not a `SceneType` * \returns nullptr if there is no `SceneType` in the list. diff --git a/Three/include/CGAL/Three/Polyhedron_demo_plugin_interface.h b/Three/include/CGAL/Three/Polyhedron_demo_plugin_interface.h index 2892bccde3f..0a5032cbb8f 100644 --- a/Three/include/CGAL/Three/Polyhedron_demo_plugin_interface.h +++ b/Three/include/CGAL/Three/Polyhedron_demo_plugin_interface.h @@ -34,12 +34,12 @@ class Scene_interface; class Polyhedron_demo_plugin_interface { public: - //! \brief Initializes the plugin + //! \brief initializes the plugin //! This function acts like a constructor. This is where the attributes must be initialized. //! The Message_interface allows to print warnings or errors on the screen and the `Console` widget. virtual void init(QMainWindow* , CGAL::Three::Scene_interface* , Messages_interface*) = 0; - //! \brief Indicates if an action is usable or not. + //! \brief indicates if an action is usable or not. //! This function usually tests the type of the selected item to determine if `action` can be applied to it, //! but not necessarly. //! @returns \c true if `action` can be called in the current state, \c false @@ -47,7 +47,7 @@ public: virtual bool applicable(QAction* action) const = 0; //!Contains all the plugin's actions. virtual QList actions() const = 0; - //!\brief Is called when the application is closed. + //!\brief is called when the application is closed. //! Override this function if you need to perform a specific action //! when the application is closed, like hide the widgets if you don't want //! their visibility to be saved. diff --git a/Three/include/CGAL/Three/Primitive_container.h b/Three/include/CGAL/Three/Primitive_container.h index bec6e4872a2..34dea54aa66 100644 --- a/Three/include/CGAL/Three/Primitive_container.h +++ b/Three/include/CGAL/Three/Primitive_container.h @@ -193,7 +193,7 @@ public: //! setter for the texture data at UV coordinates (`i`,`j`). void setTextureData (int i, int j, int r, int g, int b); //! - //! \brief Returns the `Vao` bound to `viewer`. + //! \brief returns the `Vao` bound to `viewer`. //! Vao* getVao(Viewer_interface* viewer)const; //! diff --git a/Three/include/CGAL/Three/Scene_draw_interface.h b/Three/include/CGAL/Three/Scene_draw_interface.h index 3a77569d102..f65a44c7192 100644 --- a/Three/include/CGAL/Three/Scene_draw_interface.h +++ b/Three/include/CGAL/Three/Scene_draw_interface.h @@ -35,7 +35,7 @@ public: */ virtual void initializeGL(CGAL::Three::Viewer_interface*) = 0; - //! \brief Draws the items. + //! \brief draws the items. //! It is called by Viewer::draw(). virtual void draw(CGAL::Three::Viewer_interface*) = 0; //!\brief draws the scene in a hidden frame to perform picking. @@ -43,7 +43,7 @@ public: virtual void drawWithNames(CGAL::Three::Viewer_interface*) = 0; //!Pick the point `e` on the screen. virtual void setPickedPixel(const QPoint &e) = 0; - //! \brief Manages the key events. + //! \brief manages the key events. //! Override this function to perform actions when keys are pressed. //! @returns true if the keyEvent executed well. //! diff --git a/Three/include/CGAL/Three/Scene_group_item.h b/Three/include/CGAL/Three/Scene_group_item.h index 626e69240ab..c70068a7ad3 100644 --- a/Three/include/CGAL/Three/Scene_group_item.h +++ b/Three/include/CGAL/Three/Scene_group_item.h @@ -45,14 +45,14 @@ public : //!Returns true to avoid disturbing the BBox of the scene. bool isEmpty() const Q_DECL_OVERRIDE; /*! - * \brief Locks a child + * \brief locks a child * * A locked child cannot be moved out of the group nor can it be deleted. * Use it to prevent a child to be destroyed without its parent. */ void lockChild(CGAL::Three::Scene_item*); /*! - * \brief Locks a child + * \brief locks a child * * A locked child cannot be moved out of the group nor can it be deleted. * Use it to prevent a child to be destroyed without its parent. @@ -60,25 +60,25 @@ public : void lockChild(Scene_interface::Item_id id); /*! - * \brief Unlocks a child + * \brief unlocks a child * * @see lockChild() */ void unlockChild(CGAL::Three::Scene_item*); /*! - * \brief Unlocks a child + * \brief unlocks a child * * @see lockChild() */ void unlockChild(Scene_interface::Item_id id); /*! - * \brief Tells if a child is locked. + * \brief tells if a child is locked. * \return true if the child is locked. * @see lockChild() */ bool isChildLocked(CGAL::Three::Scene_item*); /*! - * \brief Tells if a child is locked. + * \brief tells if a child is locked. * \return true if the child is locked. * @see lockChild() */ @@ -192,7 +192,7 @@ public : //!Sets the alpha value for the froup and all its children. virtual void setAlpha(int) Q_DECL_OVERRIDE; - //! \brief Returns a list of all the direct children. + //! \brief returns a list of all the direct children. //! //! Only returns children that have this item as a parent. //! Children of these children are not returned. @@ -229,7 +229,7 @@ public : void compute_bbox() const Q_DECL_OVERRIDE{}; public Q_SLOTS: - //!\brief Redraws children. + //!\brief redraws children. //! //! As each drawing function of a group draws all parts of its children, //! once any of these functions is called, we skip all drawing calls diff --git a/Three/include/CGAL/Three/Scene_interface.h b/Three/include/CGAL/Three/Scene_interface.h index 4f42bcbb4cf..c4b0a619396 100644 --- a/Three/include/CGAL/Three/Scene_interface.h +++ b/Three/include/CGAL/Three/Scene_interface.h @@ -72,7 +72,7 @@ public: virtual Item_id addItem(CGAL::Three::Scene_item* item) = 0; //!Adds a CGAL::Three::Scene_item* to the list of children. virtual void addChild(Scene_item* item)=0; - //! \brief Replaces an item by a new one in the scene. + //! \brief replaces an item by a new one in the scene. //! The item which id is `id` is replaced by `item`. //! The first one is deleted and gives its index to the second one. //! If emit_item_about_to_be_destroyed is true, emits @@ -150,7 +150,7 @@ public: //! virtual void setUpdatesEnabled(bool b) =0; //! - //! \brief Updates all the items in the SceneView. + //! \brief updates all the items in the SceneView. //! virtual void allItemsChanged() = 0; }; // end interface Scene_interface diff --git a/Three/include/CGAL/Three/Scene_item.h b/Three/include/CGAL/Three/Scene_item.h index 517d044bb4a..2b3f2fd83c1 100644 --- a/Three/include/CGAL/Three/Scene_item.h +++ b/Three/include/CGAL/Three/Scene_item.h @@ -96,7 +96,7 @@ public: //! This is where the vectors of VBOs and VAOs are initialized. Scene_item(int buffers_size = 20, int vaos_size = 10); - //! \brief Sets the number of isolated vertices. + //! \brief sets the number of isolated vertices. //! //! This number will be displayed in a warning box at loading. //! @see getNbIsolatedvertices @@ -105,12 +105,12 @@ public: //! @see setNbIsolatedvertices std::size_t getNbIsolatedvertices() const {return nb_isolated_vertices;} virtual ~Scene_item(); - //! \brief Duplicates the item. + //! \brief duplicates the item. //! //! Creates a new item as a copy of this one. virtual Scene_item* clone() const = 0; - //! \brief Indicates if `m` is supported + //! \brief indicates if `m` is supported //! //! If it is, it will be displayed in the context menu of the item. virtual bool supportsRenderingMode(RenderingMode m) const = 0; @@ -163,7 +163,7 @@ public: virtual QFont font() const { return QFont(); } // Functions that help the Scene to compute its bbox - //! \brief Determines if the item is finite or not. + //! \brief determines if the item is finite or not. //! //! For example, a plane is not finite. //! If false, the BBox is not computed. diff --git a/Three/include/CGAL/Three/Scene_print_item_interface.h b/Three/include/CGAL/Three/Scene_print_item_interface.h index 3ad79996463..7a36ee942a4 100644 --- a/Three/include/CGAL/Three/Scene_print_item_interface.h +++ b/Three/include/CGAL/Three/Scene_print_item_interface.h @@ -44,13 +44,13 @@ public: //! Prints all the primitive ids if their number is not too high. The limit is //! editable in the View menu of the application. virtual void printAllIds() = 0; - //! \brief Tests if an id should be displayed or not. + //! \brief tests if an id should be displayed or not. //! //! \returns true if the Id should be displayed //! \returns false if the Id should not be displayed (if it is hidden for example) virtual bool testDisplayId(double, double, double, CGAL::Three::Viewer_interface*)const = 0; - //! \brief Tests if this item should display its ids. + //! \brief tests if this item should display its ids. //! //! The default behavior is to only display ids of the currently selected item (\see mainSelectionIndex()). //! This function allows to override this behavior. diff --git a/Three/include/CGAL/Three/TextRenderer.h b/Three/include/CGAL/Three/TextRenderer.h index 678a3cfc0b9..8b0b7d41c07 100644 --- a/Three/include/CGAL/Three/TextRenderer.h +++ b/Three/include/CGAL/Three/TextRenderer.h @@ -144,7 +144,7 @@ public: //! //! @see addText(float p_x, float p_y, float p_z, QString p_text, bool p_3D = true, QFont font = QFont(), QColor p_color = Qt::black) void addText(TextItem*); - //!\brief Creates a new TextItem in TextRenderer::local_textItems + //!\brief creates a new TextItem in TextRenderer::local_textItems //! //!This is a version of addText(TextItem*) that creates the TextItem on the fly. //! @see addText(TextItem*) diff --git a/Three/include/CGAL/Three/Three.h b/Three/include/CGAL/Three/Three.h index 38b2ac8ea7d..dc0b688a7db 100644 --- a/Three/include/CGAL/Three/Three.h +++ b/Three/include/CGAL/Three/Three.h @@ -58,7 +58,7 @@ public: */ void addDockWidget(QDockWidget* dock_widget); - /*! \brief Gets an item of the templated type. + /*! \brief gets an item of the templated type. * \returns the first `SceneType` item found in the scene's list of currently selected * items; * \returns nullptr if there is no `SceneType` in the list. diff --git a/Three/include/CGAL/Three/Viewer_interface.h b/Three/include/CGAL/Three/Viewer_interface.h index 8498ccb2fef..130e26332de 100644 --- a/Three/include/CGAL/Three/Viewer_interface.h +++ b/Three/include/CGAL/Three/Viewer_interface.h @@ -84,15 +84,15 @@ public: - //! \brief Tests if an id should be displayed or not. + //! \brief tests if an id should be displayed or not. //! \param x, y, z the coordinates of the id's position. //! \return true if the ID should be displayed. virtual bool testDisplayId(double x, double y, double z) = 0; - //! \brief Updates the item's displayed ids. + //! \brief updates the item's displayed ids. //! //! Call this after the mesh or its ids have changed. virtual void updateIds(CGAL::Three::Scene_item *) = 0; - //! \brief Specifies if the items ids are being displayed. + //! \brief specifies if the items ids are being displayed. //! //! \returns true if the primitive ids are currently displayed virtual bool hasText() const { return false; } @@ -112,7 +112,7 @@ public: : QGLViewer(shared_widget->context(),parent){} virtual ~Viewer_interface() {} - //! \brief Sets the scene for the viewer. + //! \brief sets the scene for the viewer. virtual void setScene(CGAL::Three::Scene_draw_interface* scene) = 0; //! \brief The antialiasing state. //! @@ -120,7 +120,7 @@ public: virtual bool antiAliasing() const = 0; // Those two functions are defined in Viewer.cpp - //! \brief Sets the position and orientation of a frame using a QString. + //! \brief sets the position and orientation of a frame using a QString. //! \param s is usually gotten by dumpFrame() and is of the form "Px Py Pz O1 O2 O3 O4 ", with //! - Px to Py : the new position coordinates, //! - O1 to O3 : axis coordinate *sin(angle/2) @@ -129,7 +129,7 @@ public: //! @returns true if it worked. //! @see moveCameraToCoordinates() static bool readFrame(QString s, CGAL::qglviewer::Frame& frame); - //! \brief Gives information about a frame. + //! \brief gives information about a frame. //! @see readFrame //! @see dumpCameraCoordinates() //!@returns a QString containing the position and orientation of a frame. @@ -147,7 +147,7 @@ public: //! @returns true if the viewer is drawing with names. virtual bool inDrawWithNames() const = 0; - //! \brief Passes all the uniform data to the shaders. + //! \brief passes all the uniform data to the shaders. //! //! According to program_name, this data may change. //! This should be called in every Scene_item::draw() call. @@ -166,7 +166,7 @@ public: */ virtual void disableClippingBox()= 0; - //! \brief Returns a program according to name. + //! \brief returns a program according to name. //! //! If the program does not exist yet, it is created and stored in shader_programs. //! @see OpenGL_program_IDs @@ -197,7 +197,7 @@ public: //! Sets the combination SHIFT+LEFT CLICK to perform a selection on the screen. //! This is used to perform picking. virtual void setBindingSelect() = 0; - //!\brief Disable the picking from the keyboard and mouse + //!\brief disable the picking from the keyboard and mouse //! //! Unbinds the combination SHIFT+LEFT CLICK. It allows to //! avoid conflicts in the selection_tool, for example. @@ -241,7 +241,7 @@ public Q_SLOTS: //! If b is true, then a special color mask is applied to points and meshes to differenciate //! front-faced and back-faced elements. virtual void setBackFrontShading(bool b) =0; - //! \brief Sets the fast drawing mode + //! \brief sets the fast drawing mode //! @see inFastDrawing() virtual void setFastDrawing(bool b) = 0; //! Makes the camera turn around. @@ -249,7 +249,7 @@ public Q_SLOTS: //! @returns a QString containing the position and orientation of the camera. //! @see dumpFrame() virtual QString dumpCameraCoordinates() = 0; -//! \brief Moves the camera to the new coordinates. +//! \brief moves the camera to the new coordinates. //! //! The movement is performed through an animation. //! \param target is usually gotten by dumpCameraCoordinates() and is of the form "Px Py Pz O1 O2 O3 O4 ", with