doxygen-ize comments in sw/source/core/draw

Change-Id: I04ef6f0992e6d00dd6519eb6e9bcddecbb97e8de

sw/source/core/draw/dflyobj.cxx

@@ -23,7 +23,6 @@
 #include <editeng/opaqitem.hxx>
 #include <svx/svdpage.hxx>
 
-
 #include <fmtclds.hxx>
 #include <fmtornt.hxx>
 #include <fmtfsize.hxx>
@@ -70,19 +69,25 @@ namespace sdr
 {
     namespace contact
     {
-        // #i95264# currently needed since createViewIndependentPrimitive2DSequence()
-        // is called when RecalcBoundRect() is used. There should currently no VOCs being
-        // constructed since it gets not visualized (instead the corresponding SwVirtFlyDrawObj's
-        // referencing this one are visualized).
+        /**
+         * @see #i95264#
+         *
+         * currently needed since createViewIndependentPrimitive2DSequence() is called when
+         * RecalcBoundRect() is used. There should currently no VOCs being constructed since it
+         * gets not visualized (instead the corresponding SwVirtFlyDrawObj's referencing this one
+         * are visualized).
+         */
         class VCOfSwFlyDrawObj : public ViewContactOfSdrObj
         {
         protected:
-            // This method is responsible for creating the graphical visualisation data
-            // ONLY based on model data
+            /** This method is responsible for creating the graphical visualisation data
+             *
+             * @note ONLY based on model data
+             */
             virtual drawinglayer::primitive2d::Primitive2DSequence createViewIndependentPrimitive2DSequence() const;
 
         public:
-            // basic constructor, used from SdrObject.
+            /// basic constructor, used from SdrObject.
             VCOfSwFlyDrawObj(SwFlyDrawObj& rObj)
             :   ViewContactOfSdrObj(rObj)
             {
@@ -131,16 +136,14 @@ sal_uInt32 SwFlyDrawObj::GetObjInventor() const
     return SWGInventor;
 }
 
-
 sal_uInt16 SwFlyDrawObj::GetObjIdentifier() const
 {
     return SwFlyDrawObjIdentifier;
 }
 
-
 // SwVirtFlyDrawObj::CToren, Dtor
 
-// AW: Need own primitive to get the FlyFrame paint working
+// TODO: Need own primitive to get the FlyFrame paint working
 
 namespace drawinglayer
 {
@@ -153,7 +156,7 @@ namespace drawinglayer
             const basegfx::B2DRange                 maOuterRange;
 
         protected:
-            // method which is to be used to implement the local decomposition of a 2D primitive
+            /// method which is to be used to implement the local decomposition of a 2D primitive
             virtual Primitive2DSequence create2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const;
 
         public:
@@ -179,7 +182,7 @@ namespace drawinglayer
             const SwVirtFlyDrawObj& getSwVirtFlyDrawObj() const { return mrSwVirtFlyDrawObj; }
             const basegfx::B2DRange& getOuterRange() const { return maOuterRange; }
 
-            // provide unique ID
+            /// provide unique ID
             DeclPrimitrive2DIDBlock()
         };
     } // end of namespace primitive2d
@@ -261,19 +264,21 @@ namespace sdr
         class VCOfSwVirtFlyDrawObj : public ViewContactOfVirtObj
         {
         protected:
-            // This method is responsible for creating the graphical visualisation data
-            // ONLY based on model data
+            /** This method is responsible for creating the graphical visualisation data
+             *
+             * @note ONLY based on model data
+             */
             virtual drawinglayer::primitive2d::Primitive2DSequence createViewIndependentPrimitive2DSequence() const;
 
         public:
-            // basic constructor, used from SdrObject.
+            /// basic constructor, used from SdrObject.
             VCOfSwVirtFlyDrawObj(SwVirtFlyDrawObj& rObj)
             :   ViewContactOfVirtObj(rObj)
             {
             }
             virtual ~VCOfSwVirtFlyDrawObj();
 
-            // access to SwVirtFlyDrawObj
+            /// access to SwVirtFlyDrawObj
             SwVirtFlyDrawObj& GetSwVirtFlyDrawObj() const
             {
                 return (SwVirtFlyDrawObj&)mrObject;
@@ -317,7 +322,6 @@ namespace sdr
     } // end of namespace contact
 } // end of namespace sdr
 
-
 basegfx::B2DRange SwVirtFlyDrawObj::getOuterBound() const
 {
     basegfx::B2DRange aOuterRange;
@@ -529,26 +533,22 @@ const Rectangle& SwVirtFlyDrawObj::GetLastBoundRect() const
     return GetCurrentBoundRect();
 }
 
-
 void SwVirtFlyDrawObj::RecalcBoundRect()
 {
     SetRect();
 }
 
-
 void SwVirtFlyDrawObj::RecalcSnapRect()
 {
     SetRect();
 }
 
-
 const Rectangle& SwVirtFlyDrawObj::GetSnapRect()  const
 {
     SetRect();
     return aOutRect;
 }
 
-
 void SwVirtFlyDrawObj::SetSnapRect(const Rectangle& )
 {
     Rectangle aTmp( GetLastBoundRect() );
@@ -559,20 +559,17 @@ void SwVirtFlyDrawObj::SetSnapRect(const Rectangle& )
         pUserCall->Changed(*this, SDRUSERCALL_RESIZE, aTmp);
 }
 
-
 void SwVirtFlyDrawObj::NbcSetSnapRect(const Rectangle& )
 {
     SetRect();
 }
 
-
 const Rectangle& SwVirtFlyDrawObj::GetLogicRect() const
 {
     SetRect();
     return aOutRect;
 }
 
-
 void SwVirtFlyDrawObj::SetLogicRect(const Rectangle& )
 {
     Rectangle aTmp( GetLastBoundRect() );
@@ -583,13 +580,11 @@ void SwVirtFlyDrawObj::SetLogicRect(const Rectangle& )
         pUserCall->Changed(*this, SDRUSERCALL_RESIZE, aTmp);
 }
 
-
 void SwVirtFlyDrawObj::NbcSetLogicRect(const Rectangle& )
 {
     SetRect();
 }
 
-
 ::basegfx::B2DPolyPolygon SwVirtFlyDrawObj::TakeXorPoly() const
 {
     const Rectangle aSourceRectangle(GetFlyFrm()->Frm().SVRect());
@@ -748,7 +743,6 @@ void SwVirtFlyDrawObj::NbcMove(const Size& rSiz)
         pFmt->SetFmtAttr( aSet );
 }
 
-
 void SwVirtFlyDrawObj::NbcResize(const Point& rRef,
             const Fraction& xFact, const Fraction& yFact)
 {
@@ -856,7 +850,6 @@ void SwVirtFlyDrawObj::NbcResize(const Point& rRef,
     }
 }
 
-
 void SwVirtFlyDrawObj::Move(const Size& rSiz)
 {
     NbcMove( rSiz );
@@ -864,7 +857,6 @@ void SwVirtFlyDrawObj::Move(const Size& rSiz)
     GetFmt()->GetDoc()->GetIDocumentUndoRedo().DoDrawUndo(false);
 }
 
-
 void SwVirtFlyDrawObj::Resize(const Point& rRef,
                     const Fraction& xFact, const Fraction& yFact, bool /*bUnsetRelative*/)
 {
@@ -880,14 +872,12 @@ Pointer  SwVirtFlyDrawObj::GetMacroPointer(
     return Pointer( POINTER_REFHAND );
 }
 
-
 bool SwVirtFlyDrawObj::HasMacro() const
 {
     const SwFmtURL &rURL = pFlyFrm->GetFmt()->GetURL();
     return rURL.GetMap() || rURL.GetURL().Len();
 }
 
-
 SdrObject* SwVirtFlyDrawObj::CheckMacroHit( const SdrObjMacroHitRec& rRec ) const
 {
     const SwFmtURL &rURL = pFlyFrm->GetFmt()->GetURL();

sw/source/core/draw/drawdoc.cxx

@@ -17,7 +17,6 @@
  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  */
 
-
 #include <svx/svxids.hrc>
 #include <tools/stream.hxx>
 #include <unotools/pathoptions.hxx>
@@ -125,11 +124,13 @@ SwDrawDocument::~SwDrawDocument()
     ClearModel(sal_True);
 }
 
-// This method creates a new page (SdPage) and thereupon returns a pointer
-// to it back. The drawing engine is using this method while loading for
-// the creating of pages (whose type it not even know, because they are
-// inherited from SdrPage).
-
+/** Create a new page (SdPage) and return a pointer to it back.
+ *
+ * The drawing engine is using this method while loading for the creating of
+ * pages (whose type it not even know, because they are inherited from SdrPage).
+ *
+ * @return Pointer to the new page.
+ */
 SdrPage* SwDrawDocument::AllocPage(bool bMasterPage)
 {
     SwDPage* pPage = new SwDPage(*this, 0 != bMasterPage);
@@ -150,7 +151,6 @@ SdrLayerID SwDrawDocument::GetControlExportLayerId( const SdrObject & ) const
 
 uno::Reference< uno::XInterface > SwDrawDocument::createUnoModel()
 {
-
     uno::Reference< uno::XInterface > xModel;
 
     try
@@ -168,5 +168,4 @@ uno::Reference< uno::XInterface > SwDrawDocument::createUnoModel()
     return xModel;
 }
 
-
 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */

sw/source/core/draw/dview.cxx

@@ -202,9 +202,7 @@ SdrObject* SwDrawView::CheckSingleSdrObjectHit(const Point& rPnt, sal_uInt16 nTo
     return pRetval;
 }
 
-// SwDrawView::AddCustomHdl()
-// Gets called every time the handles need to be build
-
+/// Gets called every time the handles need to be build
 void SwDrawView::AddCustomHdl()
 {
     const SdrMarkList &rMrkList = GetMarkedObjectList();
@@ -317,11 +315,7 @@ SdrObject* SwDrawView::GetMaxToBtmObj(SdrObject* pObj) const
     return 0;
 }
 
-// SwDrawView::ObjOrderChanged()
-
-// determine maximal order number for a 'child' object of given 'parent' object
-// @author OD
-
+/// determine maximal order number for a 'child' object of given 'parent' object
 sal_uInt32 SwDrawView::_GetMaxChildOrdNum( const SwFlyFrm& _rParentObj,
                                            const SdrObject* _pExclChildObj ) const
 {
@@ -353,11 +347,7 @@ sal_uInt32 SwDrawView::_GetMaxChildOrdNum( const SwFlyFrm& _rParentObj,
     return nMaxChildOrdNum;
 }
 
-/** method to move 'repeated' objects of the given moved object to the
- *  according level
- *
- *  @author OD
- */
+/// method to move 'repeated' objects of the given moved object to the according level
 void SwDrawView::_MoveRepeatedObjs( const SwAnchoredObject& _rMovedAnchoredObj,
                                     const std::vector<SdrObject*>& _rMovedChildObjs ) const
 {
@@ -908,11 +898,7 @@ void SwDrawView::CheckPossibilities()
     bResizeProtect  |= bProtect | bSzProtect;
 }
 
-/** replace marked <SwDrawVirtObj>-objects by its reference object for delete
- *  marked objects.
- *
- *  @author OD
-*/
+/// replace marked <SwDrawVirtObj>-objects by its reference object for delete marked objects.
 void SwDrawView::ReplaceMarkedDrawVirtObjs( SdrMarkView& _rMarkView )
 {
     SdrPageView* pDrawPageView = _rMarkView.GetSdrPageView();