#i105323# added documentation to primitives

1 files changed, 122 insertions, 36 deletions

diff --git a/drawinglayer/inc/drawinglayer/primitive2d/polypolygonprimitive2d.hxx b/drawinglayer/inc/drawinglayer/primitive2d/polypolygonprimitive2d.hxx
index 0a288cd2ac65..8c0512402120 100644
--- a/drawinglayer/inc/drawinglayer/primitive2d/polypolygonprimitive2d.hxx
+++ b/drawinglayer/inc/drawinglayer/primitive2d/polypolygonprimitive2d.hxx
@@ -51,30 +51,40 @@ namespace drawinglayer
 {
     namespace primitive2d
     {
+        /** PolyPolygonHairlinePrimitive2D class
+
+            This primitive defines a multi-PolygonHairlinePrimitive2D and is
+            just for convenience. The definition is not different from the single
+            defined PolygonHairlinePrimitive2Ds.
+         */
         class PolyPolygonHairlinePrimitive2D : public BufferedDecompositionPrimitive2D
         {
         private:
+            /// the hairline geometry
             basegfx::B2DPolyPolygon                 maPolyPolygon;
+
+            /// the hairline color
             basegfx::BColor                         maBColor;
 
         protected:
-            // local decomposition.
+            /// local decomposition.
             virtual Primitive2DSequence create2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const;
 
         public:
+            /// constructor
             PolyPolygonHairlinePrimitive2D(const basegfx::B2DPolyPolygon& rPolyPolygon, const basegfx::BColor& rBColor);
 
-            // get data
+            /// data read access
             basegfx::B2DPolyPolygon getB2DPolyPolygon() const { return maPolyPolygon; }
             const basegfx::BColor& getBColor() const { return maBColor; }
 
-            // compare operator
+            /// compare operator
             virtual bool operator==(const BasePrimitive2D& rPrimitive) const;
 
-            // get range
+            /// get range
             virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const;
 
-            // provide unique ID
+            /// provide unique ID
             DeclPrimitrive2DIDBlock()
         };
     } // end of namespace primitive2d
@@ -87,38 +97,50 @@ namespace drawinglayer
 {
     namespace primitive2d
     {
+        /** PolyPolygonMarkerPrimitive2D class
+
+            This primitive defines a multi-PolygonMarkerPrimitive2D and is
+            just for convenience. The definition is not different from the single
+            defined PolygonMarkerPrimitive2Ds.
+         */
         class PolyPolygonMarkerPrimitive2D : public BufferedDecompositionPrimitive2D
         {
         private:
+            /// the marker hairline geometry
             basegfx::B2DPolyPolygon                 maPolyPolygon;
+
+            /// the two colors
             basegfx::BColor                         maRGBColorA;
             basegfx::BColor                         maRGBColorB;
+
+            /// the dash distance in 'pixels'
             double                                  mfDiscreteDashLength;
 
         protected:
-            // local decomposition.
+            /// local decomposition.
             virtual Primitive2DSequence create2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const;
 
         public:
+            /// constructor
             PolyPolygonMarkerPrimitive2D(
                 const basegfx::B2DPolyPolygon& rPolyPolygon,
                 const basegfx::BColor& rRGBColorA,
                 const basegfx::BColor& rRGBColorB,
                 double fDiscreteDashLength);
 
-            // get data
+            // data read access
             basegfx::B2DPolyPolygon getB2DPolyPolygon() const { return maPolyPolygon; }
             const basegfx::BColor& getRGBColorA() const { return maRGBColorA; }
             const basegfx::BColor& getRGBColorB() const { return maRGBColorB; }
             double getDiscreteDashLength() const { return mfDiscreteDashLength; }
 
-            // compare operator
+            /// compare operator
             virtual bool operator==(const BasePrimitive2D& rPrimitive) const;
 
-            // get range
+            /// get range
             virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const;
 
-            // provide unique ID
+            /// provide unique ID
             DeclPrimitrive2DIDBlock()
         };
     } // end of namespace primitive2d
@@ -131,39 +153,52 @@ namespace drawinglayer
 {
     namespace primitive2d
     {
+        /** PolyPolygonStrokePrimitive2D class
+
+            This primitive defines a multi-PolygonStrokePrimitive2D and is
+            just for convenience. The definition is not different from the single
+            defined PolygonStrokePrimitive2Ds.
+         */
         class PolyPolygonStrokePrimitive2D : public BufferedDecompositionPrimitive2D
         {
         private:
+            /// the line geometry
             basegfx::B2DPolyPolygon                 maPolyPolygon;
+
+            /// the line attributes like width, join and color
             attribute::LineAttribute                maLineAttribute;
+
+            /// the line stroking (if used)
             attribute::StrokeAttribute              maStrokeAttribute;
 
         protected:
-            // local decomposition.
+            /// local decomposition.
             virtual Primitive2DSequence create2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const;
 
         public:
+            /// constructor
             PolyPolygonStrokePrimitive2D(
                 const basegfx::B2DPolyPolygon& rPolyPolygon,
                 const attribute::LineAttribute& rLineAttribute,
                 const attribute::StrokeAttribute& rStrokeAttribute);
 
+            /// constructor without stroking
             PolyPolygonStrokePrimitive2D(
                 const basegfx::B2DPolyPolygon& rPolyPolygon,
                 const attribute::LineAttribute& rLineAttribute);
 
-            // get data
+            /// data read access
             basegfx::B2DPolyPolygon getB2DPolyPolygon() const { return maPolyPolygon; }
             const attribute::LineAttribute& getLineAttribute() const { return maLineAttribute; }
             const attribute::StrokeAttribute& getStrokeAttribute() const { return maStrokeAttribute; }
 
-            // compare operator
+            /// compare operator
             virtual bool operator==(const BasePrimitive2D& rPrimitive) const;
 
-            // get range
+            /// get range
             virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const;
 
-            // provide unique ID
+            /// provide unique ID
             DeclPrimitrive2DIDBlock()
         };
     } // end of namespace primitive2d
@@ -176,17 +211,25 @@ namespace drawinglayer
 {
     namespace primitive2d
     {
+        /** PolyPolygonStrokePrimitive2D class
+
+            This primitive defines a multi-PolygonStrokeArrowPrimitive2D and is
+            just for convenience. The definition is not different from the single
+            defined PolygonStrokeArrowPrimitive2Ds.
+         */
         class PolyPolygonStrokeArrowPrimitive2D : public PolyPolygonStrokePrimitive2D
         {
         private:
+            /// geometric definitions for line start and end
             attribute::LineStartEndAttribute                maStart;
             attribute::LineStartEndAttribute                maEnd;
 
         protected:
-            // local decomposition.
+            /// local decomposition.
             virtual Primitive2DSequence create2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const;
 
         public:
+            /// constructor
             PolyPolygonStrokeArrowPrimitive2D(
                 const basegfx::B2DPolyPolygon& rPolyPolygon,
                 const attribute::LineAttribute& rLineAttribute,
@@ -194,23 +237,24 @@ namespace drawinglayer
                 const attribute::LineStartEndAttribute& rStart,
                 const attribute::LineStartEndAttribute& rEnd);
 
+            /// constructor without stroking
             PolyPolygonStrokeArrowPrimitive2D(
                 const basegfx::B2DPolyPolygon& rPolyPolygon,
                 const attribute::LineAttribute& rLineAttribute,
                 const attribute::LineStartEndAttribute& rStart,
                 const attribute::LineStartEndAttribute& rEnd);
 
-            // get data
+            /// data read access
             const attribute::LineStartEndAttribute& getStart() const { return maStart; }
             const attribute::LineStartEndAttribute& getEnd() const { return maEnd; }
 
-            // compare operator
+            /// compare operator
             virtual bool operator==(const BasePrimitive2D& rPrimitive) const;
 
-            // get range
+            /// get range
             virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const;
 
-            // provide unique ID
+            /// provide unique ID
             DeclPrimitrive2DIDBlock()
         };
     } // end of namespace primitive2d
@@ -223,28 +267,38 @@ namespace drawinglayer
 {
     namespace primitive2d
     {
+        /** PolyPolygonColorPrimitive2D class
+
+            This primitive defines a PolyPolygon filled with a single color.
+            This is one of the non-decomposable primitives, so a renderer
+            should proccess it.
+         */
         class PolyPolygonColorPrimitive2D : public BasePrimitive2D
         {
         private:
+            /// the PolyPolygon geometry
             basegfx::B2DPolyPolygon                 maPolyPolygon;
+
+            /// the polygon fill color
             basegfx::BColor                         maBColor;
 
         public:
+            /// constructor
             PolyPolygonColorPrimitive2D(
                 const basegfx::B2DPolyPolygon& rPolyPolygon,
                 const basegfx::BColor& rBColor);
 
-            // get data
+            /// data read access
             const basegfx::B2DPolyPolygon& getB2DPolyPolygon() const { return maPolyPolygon; }
             const basegfx::BColor& getBColor() const { return maBColor; }
 
-            // compare operator
+            /// compare operator
             virtual bool operator==(const BasePrimitive2D& rPrimitive) const;
 
-            // get range
+            /// get range
             virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const;
 
-            // provide unique ID
+            /// provide unique ID
             DeclPrimitrive2DIDBlock()
         };
     } // end of namespace primitive2d
@@ -257,29 +311,39 @@ namespace drawinglayer
 {
     namespace primitive2d
     {
+        /** PolyPolygonColorPrimitive2D class
+
+            This primitive defines a PolyPolygon filled with a gradient. The
+            decomosition will create a MaskPrimitive2D containing a
+            FillGradientPrimitive2D.
+         */
         class PolyPolygonGradientPrimitive2D : public BufferedDecompositionPrimitive2D
         {
         private:
+            /// the PolyPolygon geometry
             basegfx::B2DPolyPolygon                     maPolyPolygon;
+
+            /// the gradient definition
             attribute::FillGradientAttribute            maFillGradient;
 
         protected:
-            // local decomposition.
+            /// local decomposition.
             virtual Primitive2DSequence create2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const;
 
         public:
+            /// constructor
             PolyPolygonGradientPrimitive2D(
                 const basegfx::B2DPolyPolygon& rPolyPolygon,
                 const attribute::FillGradientAttribute& rFillGradient);
 
-            // get data
+            /// data read access
             const basegfx::B2DPolyPolygon& getB2DPolyPolygon() const { return maPolyPolygon; }
             const attribute::FillGradientAttribute& getFillGradient() const { return maFillGradient; }
 
-            // compare operator
+            /// compare operator
             virtual bool operator==(const BasePrimitive2D& rPrimitive) const;
 
-            // provide unique ID
+            /// provide unique ID
             DeclPrimitrive2DIDBlock()
         };
     } // end of namespace primitive2d
@@ -292,32 +356,44 @@ namespace drawinglayer
 {
     namespace primitive2d
     {
+        /** PolyPolygonHatchPrimitive2D class
+
+            This primitive defines a PolyPolygon filled with a hatch. The
+            decomosition will create a MaskPrimitive2D containing a
+            FillHatchPrimitive2D.
+         */
         class PolyPolygonHatchPrimitive2D : public BufferedDecompositionPrimitive2D
         {
         private:
+            /// the PolyPolygon geometry
             basegfx::B2DPolyPolygon                     maPolyPolygon;
+
+            /// the hatch definition
             attribute::FillHatchAttribute               maFillHatch;
+
+            /// the hatch background color (if used)
             basegfx::BColor                             maBackgroundColor;
 
         protected:
-            // local decomposition.
+            /// local decomposition.
             virtual Primitive2DSequence create2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const;
 
         public:
+            /// constructor
             PolyPolygonHatchPrimitive2D(
                 const basegfx::B2DPolyPolygon& rPolyPolygon,
                 const basegfx::BColor& rBackgroundColor,
                 const attribute::FillHatchAttribute& rFillHatch);
 
-            // get data
+            /// data read access
             const basegfx::B2DPolyPolygon& getB2DPolyPolygon() const { return maPolyPolygon; }
             const basegfx::BColor& getBackgroundColor() const { return maBackgroundColor; }
             const attribute::FillHatchAttribute& getFillHatch() const { return maFillHatch; }
 
-            // compare operator
+            /// compare operator
             virtual bool operator==(const BasePrimitive2D& rPrimitive) const;
 
-            // provide unique ID
+            /// provide unique ID
             DeclPrimitrive2DIDBlock()
         };
     } // end of namespace primitive2d
@@ -330,29 +406,39 @@ namespace drawinglayer
 {
     namespace primitive2d
     {
+        /** PolyPolygonBitmapPrimitive2D class
+
+            This primitive defines a PolyPolygon filled with bitmap data
+            (including alpha). The decomosition will create a MaskPrimitive2D
+            containing a FillBitmapPrimitive2D.
+         */
         class PolyPolygonBitmapPrimitive2D : public BufferedDecompositionPrimitive2D
         {
         private:
+            /// the PolyPolygon geometry
             basegfx::B2DPolyPolygon                     maPolyPolygon;
+
+            /// the bitmap fill definition (may include tiling)
             attribute::FillBitmapAttribute              maFillBitmap;
 
         protected:
-            // local decomposition.
+            /// local decomposition.
             virtual Primitive2DSequence create2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const;
 
         public:
+            /// constructor
             PolyPolygonBitmapPrimitive2D(
                 const basegfx::B2DPolyPolygon& rPolyPolygon,
                 const attribute::FillBitmapAttribute& rFillBitmap);
 
-            // get data
+            /// data read access
             const basegfx::B2DPolyPolygon& getB2DPolyPolygon() const { return maPolyPolygon; }
             const attribute::FillBitmapAttribute& getFillBitmap() const { return maFillBitmap; }
 
-            // compare operator
+            /// compare operator
             virtual bool operator==(const BasePrimitive2D& rPrimitive) const;
 
-            // provide unique ID
+            /// provide unique ID
             DeclPrimitrive2DIDBlock()
         };
     } // end of namespace primitive2d