#i105323# added documentation to primitives

1 files changed, 26 insertions, 8 deletions

diff --git a/drawinglayer/inc/drawinglayer/primitive2d/gridprimitive2d.hxx b/drawinglayer/inc/drawinglayer/primitive2d/gridprimitive2d.hxx
index d2b90e271cda..4ba83fc75c88 100644
--- a/drawinglayer/inc/drawinglayer/primitive2d/gridprimitive2d.hxx
+++ b/drawinglayer/inc/drawinglayer/primitive2d/gridprimitive2d.hxx
@@ -48,29 +48,47 @@ namespace drawinglayer
 {
     namespace primitive2d
     {
+        /** GridPrimitive2D class
+
+            This primitive is specialized to Grid visualisation. The graphic definition
+            (Transform) contains the whole grid area, but will of course be combined
+            with the visible area (Viewport) when decomposed. Also a reolution-dependent
+            point reduction is used to not create too much grid visualisation data. This
+            makes this primitive highly view-dependent and it dynamically buffers
+            the last decomposition dependent from the Viewport used.
+         */
         class GridPrimitive2D : public BufferedDecompositionPrimitive2D
         {
         private:
+            /// The geometry definition for the grid area
             basegfx::B2DHomMatrix                           maTransform;
+
+            /// grid layout definitions
             double                                          mfWidth;
             double                                          mfHeight;
             double                                          mfSmallestViewDistance;
             double                                          mfSmallestSubdivisionViewDistance;
             sal_uInt32                                      mnSubdivisionsX;
             sal_uInt32                                      mnSubdivisionsY;
+
+            /// Grid color for single-pixel grid points
             basegfx::BColor                                 maBColor;
+
+            /// The Bitmap (with alpha) for grid cross points
             BitmapEx                                        maCrossMarker;
 
-            // the last used object to view transformtion and the last Viewport,
-            // used from getDecomposition for decide buffering
+            /** the last used object to view transformtion and the last Viewport,
+                used from getDecomposition for decide buffering
+             */
             basegfx::B2DHomMatrix                           maLastObjectToViewTransformation;
             basegfx::B2DRange                               maLastViewport;
 
         protected:
-            // create local decomposition
+            /// create local decomposition
             virtual Primitive2DSequence create2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const;
 
         public:
+            /// constructor
             GridPrimitive2D(
                 const basegfx::B2DHomMatrix& rTransform,
                 double fWidth,
@@ -82,7 +100,7 @@ namespace drawinglayer
                 const basegfx::BColor& rBColor,
                 const BitmapEx& rCrossMarker);
 
-            // get data
+            /// data read access
             const basegfx::B2DHomMatrix& getTransform() const { return maTransform; }
             double getWidth() const { return mfWidth; }
             double getHeight() const { return mfHeight; }
@@ -93,16 +111,16 @@ namespace drawinglayer
             const basegfx::BColor& getBColor() const { return maBColor; }
             const BitmapEx& getCrossMarker() const { return maCrossMarker; }
 
-            // compare operator
+            /// compare operator
             virtual bool operator==(const BasePrimitive2D& rPrimitive) const;
 
-            // get 2d range
+            /// get 2d range
             virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const;
 
-            // provide unique ID
+            /// provide unique ID
             DeclPrimitrive2DIDBlock()
 
-            // Overload standard getDecomposition call to be view-dependent here
+            /// Overload standard getDecomposition call to be view-dependent here
             virtual Primitive2DSequence get2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const;
         };
     } // end of namespace primitive2d