Convert documents to follow the doxygen standard (fdo#44502, fdo#39468)

Change-Id: I58c73f74d53b5dc2eb462fb03664be65d4500170
Reviewed-by: Philipp Riemer <ruderphilipp@gmail.com>

4 files changed, 31 insertions, 33 deletions

diff --git a/sd/inc/anminfo.hxx b/sd/inc/anminfo.hxx
index 605863bc2d15..72f2a96a7f8f 100644
--- a/sd/inc/anminfo.hxx
+++ b/sd/inc/anminfo.hxx
@@ -37,26 +37,26 @@ public:
     PresObjKind             mePresObjKind;
 
     /* deprecated animation infos */
-    ::com::sun::star::presentation::AnimationEffect meEffect;       ///< Animation effect
-    ::com::sun::star::presentation::AnimationEffect meTextEffect;   ///< Animation effect for text
-    ::com::sun::star::presentation::AnimationSpeed  meSpeed;        ///< Speed of the animation
+    ::com::sun::star::presentation::AnimationEffect meEffect;     ///< Animation effect
+    ::com::sun::star::presentation::AnimationEffect meTextEffect; ///< Animation effect for text content
+    ::com::sun::star::presentation::AnimationSpeed  meSpeed;      ///< Speed of the animation
     sal_Bool                    mbActive;       ///< turned on?
-    sal_Bool                    mbDimPrevious;  ///< Object Dim
-    sal_Bool                    mbIsMovie;      ///< wenn Gruppenobjekt, dann Sequenz aus den
+    sal_Bool                    mbDimPrevious;  ///< Object fade out
+    sal_Bool                    mbIsMovie;      ///< if group object than it is a sequence of them.
     sal_Bool                    mbDimHide;      ///< hide rather than dim
     Color                       maBlueScreen;   ///< identifies "background pixels"
-    Color                       maDimColor;     ///< zum Abblenden des Objekts
+    Color                       maDimColor;     ///< for fading the object
     String                      maSoundFile;    ///< Path to the sound file in MS DOS notation
     sal_Bool                    mbSoundOn;      ///< Sound on / off
-    sal_Bool                    mbPlayFull;     ///< Play sound quite
+    sal_Bool                    mbPlayFull;     ///< play sound completely.
     SdrPathObj*                 mpPathObj;      ///< The path object
     ::com::sun::star::presentation::ClickAction     meClickAction;  ///< Action at mouse click
-    ::com::sun::star::presentation::AnimationEffect meSecondEffect; ///< for  Hidden  object
-    ::com::sun::star::presentation::AnimationSpeed  meSecondSpeed;  ///< for  Hidden  object
-    String                      maSecondSoundFile; ///< for  Hidden  object
-    sal_Bool                    mbSecondSoundOn;    ///< for  Hidden  object
-    sal_Bool                    mbSecondPlayFull;///< ffor  Hidden  object
-    sal_uInt16                  mnVerb;         ///< for OLE object
+    ::com::sun::star::presentation::AnimationEffect meSecondEffect; ///< for object fading.
+    ::com::sun::star::presentation::AnimationSpeed  meSecondSpeed;  ///< for object fading.
+    String                      maSecondSoundFile; ///< for object fading.
+    sal_Bool                    mbSecondSoundOn;   ///< for object fading.
+    sal_Bool                    mbSecondPlayFull;  ///< for object fading.
+    sal_uInt16                  mnVerb;            ///< for OLE object
     sal_uLong                   mnPresOrder;
     SdrObject&              mrObject;
 
diff --git a/sd/inc/sdpage.hxx b/sd/inc/sdpage.hxx
index b6c68bb06692..9b1236a73a7e 100644
--- a/sd/inc/sdpage.hxx
+++ b/sd/inc/sdpage.hxx
@@ -118,28 +118,27 @@ friend class sd::UndoGeoObject;
 friend class sd::UndoAttrObject;
 
 protected:
-    PageKind    mePageKind;               ///< page Type
+    PageKind    mePageKind;               ///< page type
     AutoLayout  meAutoLayout;             ///< AutoLayout
-    sd::ShapeList maPresentationShapeList;            ///< presentation objects
+    sd::ShapeList maPresentationShapeList;///< presentation objects
     sd::ScopeLock maLockAutoLayoutArrangement;
     sal_Bool    mbSelected;               ///< selection identifier
     PresChange  mePresChange;             ///< manual / automatic / semi automatic
     sal_uInt32  mnTime;                   ///< Display time in seconds
-    sal_Bool    mbSoundOn;                ///< with / without sound(sal_True/sal_False)
-    sal_Bool    mbExcluded;               ///< wird in der Show nicht/doch
-                                          ///< displayed (sal_True/sal_False)
+    sal_Bool    mbSoundOn;                ///< with / without sound.
+    sal_Bool    mbExcluded;               ///< will (not) be displayed during show.
     String      maLayoutName;             ///< Name of the layout
-    String      maSoundFile;              ///< Path to Sound File (MSDOS-Notation)
+    String      maSoundFile;              ///< Path to sound file (MSDOS notation).
     bool        mbLoopSound;
     bool        mbStopSound;
-    String      maCreatedPageName;        ///< GetPageName generated by Page Name
-    String      maFileName;               ///< Filename
-    String      maBookmarkName;           ///< Bookmarkname
+    String      maCreatedPageName;        ///< generated page name by GetPageName.
+    String      maFileName;               ///< file name.
+    String      maBookmarkName;           ///< Bookmark name.
     sal_Bool    mbScaleObjects;           ///< Objects should be scaled
-    sal_Bool    mbBackgroundFullSize;     ///< Background object to represent the whole page
-    rtl_TextEncoding meCharSet;           ////< Text-Encoding
+    sal_Bool    mbBackgroundFullSize;     ///< Background object to represent the whole page.
+    rtl_TextEncoding meCharSet;           ///< Text encoding
     sal_uInt16  mnPaperBin;               ///< PaperBin
-    Orientation meOrientation;            ///< Print-Orientation
+    Orientation meOrientation;            ///< Print orientation.
     SdPageLink* mpPageLink;               ///< Page link (at left sides only)
 
     sd::AnnotationVector    maAnnotations;
@@ -271,7 +270,6 @@ public:
     double      getTransitionDuration() const;
     void        setTransitionDuration( double fTranstionDuration );
 
-    /// Virtual methods of SdrObjUserCall.
     virtual void Changed(const SdrObject& rObj, SdrUserCallType eType,
                          const Rectangle& rOldBoundRect);
 
@@ -320,7 +318,7 @@ public:
     /** sets the main animation node */
     void setAnimationNode( ::com::sun::star::uno::Reference< ::com::sun::star::animations::XAnimationNode >& xNode ) throw (::com::sun::star::uno::RuntimeException);
 
-    /** @return  a helper class to manipulate effects inside the main sequence */
+    /// @return a helper class to manipulate effects inside the main sequence
     boost::shared_ptr< sd::MainSequence > getMainSequence();
 
     /** quick check if this slide has an animation node.
@@ -329,7 +327,7 @@ public:
     */
     bool hasAnimationNode() const;
 
-    /** @return  the SdPage implementation for the given XDrawPage or 0 if not available */
+    /// @return the SdPage implementation for the given XDrawPage or 0 if not available
     static SdPage* getImplementation( const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XDrawPage >& xPage );
 
     /** removes all custom animations for the given shape */
@@ -343,9 +341,9 @@ public:
     void setHeaderFooterSettings( const sd::HeaderFooterSettings& rNewSettings );
 
     /**
-        This method
         @return true if the object from the ViewObjectContact should
         be visible on this page while rendering.
+
         bEdit selects if visibility test is for an editing view or a final render,
         like printing.
     */
diff --git a/sd/inc/sdpptwrp.hxx b/sd/inc/sdpptwrp.hxx
index 4b0c424ee284..beb4818b0a54 100644
--- a/sd/inc/sdpptwrp.hxx
+++ b/sd/inc/sdpptwrp.hxx
@@ -39,7 +39,7 @@ public:
     sal_Bool        Import();
     sal_Bool        Export();
 
-    /// restaures the original basic storage
+    /// restores the original basic storage
     void                    PreSaveBasic();
 
 private:
diff --git a/sd/inc/sdxmlwrp.hxx b/sd/inc/sdxmlwrp.hxx
index 6440d1a6ff3b..bc5055e3de3b 100644
--- a/sd/inc/sdxmlwrp.hxx
+++ b/sd/inc/sdxmlwrp.hxx
@@ -28,9 +28,9 @@
 
 enum SdXMLFilterMode
 {
-    SDXMLMODE_Normal,           /// standard load and save of the complete document
-    SDXMLMODE_Preview,          /// only for import, only the first draw page and its master page is loaded
-    SDXMLMODE_Organizer         /// only for import, only the styles are loaded
+    SDXMLMODE_Normal,   ///< standard load and save of the complete document
+    SDXMLMODE_Preview,  ///< only for import, only the first draw page and its master page is loaded
+    SDXMLMODE_Organizer ///< only for import, only the styles are loaded
 };
 
 class SdXMLFilter : public SdFilter