Add ; in doc and newline after cgalModifEnd macro.

This commit is contained in:
Guillaume Damiand 2013-11-25 13:24:58 +01:00
parent 050ce22ecb
commit 4df9e9fe7d
2 changed files with 21 additions and 8 deletions

View File

@ -7,8 +7,11 @@ namespace CGAL {
A model for `Kernel_d` that uses %Cartesian coordinates to represent the A model for `Kernel_d` that uses %Cartesian coordinates to represent the
geometric objects. The parameter `DimensionTag` is the dimension of the geometric objects. The parameter `DimensionTag` is the dimension of the
ambient Euclidean space. It may be either `Dimension_tag<d>` \cgalModifBegin where `d` is ambient Euclidean space. It may be either `Dimension_tag<d>` \cgalModifBegin where `d` is
an integer \cgalModifEnd or an integer
`Dynamic_dimension_tag`. \cgalModifBegin In the later case, the dimension of the space is specified for each point when it is constructed, so it doesn't need to be known at compile-time. \cgalModifEnd This kernel supports construction of points from `double`
\cgalModifEnd or `Dynamic_dimension_tag`. \cgalModifBegin In the later case, the dimension of the space is specified for each point when it is constructed, so it doesn't need to be known at compile-time.
\cgalModifEnd This kernel supports construction of points from `double`
%Cartesian coordinates. It provides exact geometric predicates, but %Cartesian coordinates. It provides exact geometric predicates, but
the geometric constructions are not guaranteed to be exact. The geometric the geometric constructions are not guaranteed to be exact. The geometric
predicates are made exact without sacrificing speed thanks to the use of predicates are made exact without sacrificing speed thanks to the use of
@ -47,7 +50,9 @@ Point_d(double x0, double x1, ...);
/*! \cgalModifBegin introduces a point with coordinate set `[first,end)`. /*! \cgalModifBegin introduces a point with coordinate set `[first,end)`.
\pre If `DimensionTag` is a fixed dimension, it matches `distance(first,end)`. \pre If `DimensionTag` is a fixed dimension, it matches `distance(first,end)`.
\cgalRequires The value type of `InputIterator` is convertible to `FT`.\cgalModifEnd \cgalRequires The value type of `InputIterator` is convertible to `FT`.
\cgalModifEnd
*/ */
template<typename InputIterator> template<typename InputIterator>
Point_d(InputIterator first, InputIterator end); Point_d(InputIterator first, InputIterator end);
@ -56,11 +61,15 @@ Point_d(InputIterator first, InputIterator end);
\pre `i` is non-negative and less than the dimension. */ \pre `i` is non-negative and less than the dimension. */
double operator[](int i)const; double operator[](int i)const;
/*! \cgalModifBegin returns an iterator pointing to the zeroth Cartesian coordinate.\cgalModifEnd */ /*! \cgalModifBegin returns an iterator pointing to the zeroth Cartesian coordinate.
\cgalModifEnd */
Cartesian_const_iterator_d cartesian_begin()const; Cartesian_const_iterator_d cartesian_begin()const;
/*! \cgalModifBegin returns an iterator pointing beyond the last Cartesian coordinate.\cgalModifEnd */ /*! \cgalModifBegin returns an iterator pointing beyond the last Cartesian coordinate.
\cgalModifEnd */
Cartesian_const_iterator_d cartesian_end()const; Cartesian_const_iterator_d cartesian_end()const;
} };
/// @} /// @}
}; /* end Epick_d */ }; /* end Epick_d */

View File

@ -214,7 +214,9 @@ Constructions Kernel is a kernel particularly useful when the dimension of
the space is known at compile-time; \cgalModifBegin `DimensionTag` is then the space is known at compile-time; \cgalModifBegin `DimensionTag` is then
`Dimension_tag<d>` where `d` is an integer representing the dimension. It `Dimension_tag<d>` where `d` is an integer representing the dimension. It
may also be used with parameter `Dynamic_dimension_tag`, in which case the may also be used with parameter `Dynamic_dimension_tag`, in which case the
dimension does not need to be known at compile-time.\cgalModifEnd dimension does not need to be known at compile-time.
\cgalModifEnd
It uses a Cartesian representation and It uses a Cartesian representation and
supports construction of points from `double` coordinates. It provides exact supports construction of points from `double` coordinates. It provides exact
geometric predicates, but the geometric constructions are not guaranteed to geometric predicates, but the geometric constructions are not guaranteed to
@ -240,7 +242,9 @@ they <B>always</B> consist of:
<LI>A <I>representation class</I>, which itself may be parameterized with a <LI>A <I>representation class</I>, which itself may be parameterized with a
number type, such as `Cartesian_d<double>` or `Homogeneous_d<leda_integer>`, number type, such as `Cartesian_d<double>` or `Homogeneous_d<leda_integer>`,
where the type can be found, \cgalModifBegin except for `Epick_d<DimensionTag>` where the where the type can be found, \cgalModifBegin except for `Epick_d<DimensionTag>` where the
number type is implicitly `double`\cgalModifEnd . number type is implicitly `double`
\cgalModifEnd .
</OL> </OL>
\subsection Kernel_dKernelasaTraitsClass Kernel as a Traits Class \subsection Kernel_dKernelasaTraitsClass Kernel as a Traits Class