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

Add a todo for strange brief descriptions.

This commit is contained in:
Philipp Möller 2012-09-18 10:04:30 +00:00
parent 290015d1f8
commit 4a80ebd27b
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomial_1_2.h
View File

@ -3,6 +3,10 @@
\ingroup PkgCircularKernel2AlgebraicConcepts \ingroup PkgCircularKernel2AlgebraicConcepts
\cgalconcept \cgalconcept
\todo Concepts starting like this should have a specific or empty
brief description and should place "A model..." after see also or drop
the sentence all together.
A model `fo` of this type must provide: A model `fo` of this type must provide:
\sa `CircularKernel::ConstructLine_2` \sa `CircularKernel::ConstructLine_2`

5
Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMinVertex_2.h
View File

@ -10,9 +10,6 @@ A model `fo` of this type must provide:
class CircularKernel::ConstructCircularMinVertex_2 { class CircularKernel::ConstructCircularMinVertex_2 {
public: public:
/// \name See Also
/// @{
/*! /*!
Constructs the `x`-minimal vertex of `c`. Constructs the `x`-minimal vertex of `c`.
\pre The arc `c` is `x`-monotone. \pre The arc `c` is `x`-monotone.
@ -26,7 +23,5 @@ Same, for a line segment.
CircularKernel::Circular_arc_point_2 operator() CircularKernel::Circular_arc_point_2 operator()
(const CircularKernel::Line_arc_2 & l); (const CircularKernel::Line_arc_2 & l);
/// @}
}; /* end CircularKernel::ConstructCircularMinVertex_2 */ }; /* end CircularKernel::ConstructCircularMinVertex_2 */

1
Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoOverlap_2.h
View File

@ -5,6 +5,7 @@
Testing whether the interiors of two curves overlap. Testing whether the interiors of two curves overlap.
\bug There is no DoOverlap in the Linear Kernel.
\refines ::Kernel::DoOverlap_2 \refines ::Kernel::DoOverlap_2
*/ */