workaround for a doxygen bug: remove space after /!* to avoid a verbatim env
this happens if you have an empty line or the text directly after /!* to find them in the generated documentation, grep for "pre class=\"fragment\"" (a few of them are legitimate however)
This commit is contained in:
@@ -15,7 +15,7 @@ public:
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Constructs a graphics
|
||||
item for a circular arc.
|
||||
*/
|
||||
@@ -26,17 +26,17 @@ CircularArcGraphicsItem<CK>();
|
||||
/// \name Operations
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Returns the pen used to draw edges.
|
||||
*/
|
||||
QPen edgesPen()() const;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Sets the pen used to draw edges.
|
||||
*/
|
||||
void setEdgesPen()(const QPen& p);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Sets the circular arc.
|
||||
*/
|
||||
void setArc(const Circular_arc_2<CK>& ca2);
|
||||
|
||||
@@ -16,7 +16,7 @@ public:
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Constructs
|
||||
a graphics item for triangulation `ct`.
|
||||
*/
|
||||
@@ -27,12 +27,12 @@ ConstrainedTriangulationGraphicsItem<CT>(CT* ct);
|
||||
/// \name Operations
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Returns the pen used to draw constraints.
|
||||
*/
|
||||
QPen constraintsPen()() const;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Sets the pen used to draw constraints.
|
||||
*/
|
||||
void setConstraintsPen()(const QPen& p);
|
||||
|
||||
@@ -21,7 +21,7 @@ public:
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
The clipping rect is used for unbounded \cgal objects.
|
||||
*/
|
||||
Converter<K>(QRectF clippingRect);
|
||||
@@ -31,42 +31,42 @@ Converter<K>(QRectF clippingRect);
|
||||
/// \name From CGAL to Qt
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Converts a bounding box.
|
||||
*/
|
||||
QRectF operator()(Bbox_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Converts a point.
|
||||
*/
|
||||
QPointF operator()(K::Point_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Converts a segment.
|
||||
*/
|
||||
QLineF operator()(K::Segment_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Clips the ray and converts the resulting segment.
|
||||
*/
|
||||
QLineF operator()(K::Ray_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Clips the line and converts the resulting segment.
|
||||
*/
|
||||
QLineF operator()(K::Line_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Converts a triangle.
|
||||
*/
|
||||
QPolygonF operator()(K::Triangle_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Converts an iso rectangle.
|
||||
*/
|
||||
QRectF operator()(K::Iso_rectangle_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Converts a list of points to a polygon.
|
||||
*/
|
||||
QPolygonF operator()(std::list<K::Point_2>);
|
||||
@@ -76,22 +76,22 @@ QPolygonF operator()(std::list<K::Point_2>);
|
||||
/// \name From Qt to CGAL
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Converts a point.
|
||||
*/
|
||||
K::Point_2 operator()(QPointF);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Converts a segment.
|
||||
*/
|
||||
K::Segment_2 operator()(QLineF);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Converts an iso rectangle.
|
||||
*/
|
||||
K::Iso_rectangle_2 operator()(QRectF);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Converts a polygon to a list of points.
|
||||
*/
|
||||
std::list<K::Point_2> operator()(QPolygonF);
|
||||
|
||||
@@ -15,7 +15,7 @@ public:
|
||||
/// \name Slots
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
This slot must be provided by derived classes.
|
||||
*/
|
||||
virtual void modelChanged();
|
||||
|
||||
@@ -21,7 +21,7 @@ public:
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
\param p is a parent object.
|
||||
\param s is the scene where the circle is generated.
|
||||
\param pointsOnCircle is the
|
||||
@@ -35,7 +35,7 @@ GraphicsViewCircleInput<T>(QObject *p, QGraphicsScene* s, int pointsOnCircle = 1
|
||||
/// \name Signals
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
The object `o` contains a `std::pair<K::Point_2, K::FT>`
|
||||
for center and radius, or a `std::pair<K::Point_2, K::Point_2>` for two points defining
|
||||
the circle, or `CGAL::array<K::Point_2, 3>` for three points defining
|
||||
|
||||
@@ -18,7 +18,7 @@ public:
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
\param p is a parent object.
|
||||
\param s is the scene where the circular arc is generated.
|
||||
*/
|
||||
@@ -29,7 +29,7 @@ GraphicsViewCircularArcInput<T>(QObject *p, QGraphicsScene* s);
|
||||
/// \name Signals
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
The object `o` contains a `Circular_arc_2<K>`.
|
||||
*/
|
||||
void generate(Object o);
|
||||
|
||||
@@ -13,7 +13,7 @@ public:
|
||||
/// \name Signals
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
A signal that emits a `CGAL::Object`.
|
||||
*/
|
||||
void generate(Object);
|
||||
|
||||
@@ -15,7 +15,7 @@ public:
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
\param p is a parent object.
|
||||
\param s is the scene where the iso rectangle is generated.
|
||||
*/
|
||||
@@ -26,7 +26,7 @@ GraphicsViewIsoRectangleInput<T>(QObject *p, QGraphicsScene* s);
|
||||
/// \name Signals
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
The object `o` contains a `K::Iso_rectangle_2`.
|
||||
*/
|
||||
void generate(Object o);
|
||||
|
||||
@@ -17,7 +17,7 @@ public:
|
||||
/// \name Operations
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
The event filter.
|
||||
*/
|
||||
bool eventFilter(QObject *obj, QEvent *event);
|
||||
@@ -27,7 +27,7 @@ bool eventFilter(QObject *obj, QEvent *event);
|
||||
/// \name Signals
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Emits the real world mouse coordinates.
|
||||
*/
|
||||
void mouseCoordinates(QPointF p);
|
||||
|
||||
@@ -28,7 +28,7 @@ public:
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
\param p is a parent object.
|
||||
\param s is the scene where the polyline is generated.
|
||||
\param n is the number of points of the polyline to be generated. If `n = 0`,
|
||||
@@ -44,7 +44,7 @@ bool closed = true);
|
||||
/// \name Signals
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
The object `o` contains a `std:list<K::Point_2>`.
|
||||
*/
|
||||
void generate(CGAL::Object o);
|
||||
|
||||
@@ -15,7 +15,7 @@ public:
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
The clipping rect is used for unbounded `Kernel` objects.
|
||||
*/
|
||||
PainterOstream<K>(QPainter* qp, QRectF clippingRect);
|
||||
@@ -25,62 +25,62 @@ PainterOstream<K>(QPainter* qp, QRectF clippingRect);
|
||||
/// \name Operations
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Draws a point.
|
||||
*/
|
||||
PainterOstream<K> operator<<(K::Point_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Draws a segment.
|
||||
*/
|
||||
PainterOstream<K> operator<<(K::Segment_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Draws a clipped ray.
|
||||
*/
|
||||
PainterOstream<K> operator<<(K::Ray_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Draws a clipped line.
|
||||
*/
|
||||
PainterOstream<K> operator<<(K::Line_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Draws a triangle.
|
||||
*/
|
||||
PainterOstream<K> operator<<(K::Triangle_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Draws an iso rectangle.
|
||||
*/
|
||||
PainterOstream<K> operator<<(K::Iso_rectangle_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Draws a circle.
|
||||
*/
|
||||
PainterOstream<K> operator<<(K::Circle_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Draws a circular arc.
|
||||
*/
|
||||
PainterOstream<K> operator<<(K::Circular_arc_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Draws a polyline. In order to close it the first and last point must be equal.
|
||||
*/
|
||||
PainterOstream<K> operator<<(std::list<K::Point_2>);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Draws an iso rectangle.
|
||||
*/
|
||||
PainterOstream<K> operator<<(Bbox_2);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Sets the pen used in the next paint operations.
|
||||
*/
|
||||
PainterOstream<K> operator<<(QPen);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Sets the brush used in the next paint operations.
|
||||
*/
|
||||
PainterOstream<K> operator<<(QBrush);
|
||||
|
||||
@@ -15,7 +15,7 @@ public:
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Constructs a graphics
|
||||
item for a triangulation pointed by `t`.
|
||||
*/
|
||||
@@ -26,42 +26,42 @@ TriangulationGraphicsItem<T>(T* t);
|
||||
/// \name Operations
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Returns the pen used to draw vertices.
|
||||
*/
|
||||
QPen verticesPen()() const;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Sets the pen used to draw vertices.
|
||||
*/
|
||||
void setVerticesPen()(const QPen& p);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Returns the pen used to draw edges.
|
||||
*/
|
||||
QPen edgesPen()() const;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Sets the pen used to draw edges.
|
||||
*/
|
||||
void setEdgesPen()(const QPen& p);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Returns `true`, iff vertices are drawn.
|
||||
*/
|
||||
bool visibleVertices();
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Sets the property.
|
||||
*/
|
||||
void setVisibleVertices(bool b);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Returns `true`, iff edges are drawn.
|
||||
*/
|
||||
bool visibleEdges();
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Sets the property.
|
||||
*/
|
||||
void setVisibleEdges(bool b);
|
||||
|
||||
@@ -17,7 +17,7 @@ public:
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Constructs a graphics item for the dual of the
|
||||
Delaunay triangulation `dt`.
|
||||
*/
|
||||
@@ -28,22 +28,22 @@ VoronoiGraphicsItem<DT>(DT* dt);
|
||||
/// \name Operations
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Returns the pen used to draw edges.
|
||||
*/
|
||||
QPen edgesPen()() const;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Set the pen used to draw edges.
|
||||
*/
|
||||
void setEdgesPen()(const QPen& p);
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Returns `true`, iff edges are drawn.
|
||||
*/
|
||||
bool visibleEdges();
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Set the property.
|
||||
*/
|
||||
bool setVisibleEdges(bool b);
|
||||
|
||||
Reference in New Issue
Block a user