Modifiying some comments to follow the Doxygen standards

Change-Id: Ia64c66cfaaa9ed7b1c8f3984f797ac1605fac7d4

cui/source/inc/connect.hxx

@@ -38,12 +38,7 @@
 
 class SdrView;
 
-/*************************************************************************
-|*
-|* Dialog for changing connectors.
-|*
-\************************************************************************/
-
+/// Dialog for changing connectors.
 class SvxConnectionPage : public SfxTabPage
 {
 private:
@@ -97,13 +92,8 @@ public:
     virtual void PageCreated (SfxAllItemSet aSet);
 };
 
-/*************************************************************************
-|*
-|* Derived from SfxSingleTabDialog, in order to be informed about
-|* virtual methods by the control.
-|*
-\************************************************************************/
-
+/* Derived from SfxSingleTabDialog, in order to be informed about
+   virtual methods by the control. */
 class SvxConnectionDialog : public SfxSingleTabDialog
 {
 public:

cui/source/inc/cuicharmap.hxx

@@ -39,19 +39,12 @@
 class SubsetMap;
 class SvxCharMapData;
 
-// define ----------------------------------------------------------------
-
 #define CHARMAP_MAXLEN  32
 
 namespace svx
 {
     struct SvxShowCharSetItem;
 }
-// class SvxCharacterMap -------------------------------------------------
-// the main purpose of this dialog is to enable the use of characters
-// that are not easily accesible from the keyboard
-
-// class SvxShowText =====================================================
 
 class SvxShowText : public Control
 {
@@ -111,6 +104,8 @@ friend class SvxCharacterMap;
     DECL_LINK(DeleteHdl, void *);
 };
 
+/** The main purpose of this dialog is to enable the use of characters
+    that are not easily accesible from the keyboard. */
 class SvxCharacterMap : public SfxModalDialog
 {
 private:

cui/source/inc/cuifmsearch.hxx

@@ -47,14 +47,11 @@ namespace svxform {
     class FmSearchConfigItem;
 }
 
-// ===================================================================================================
-// = class FmSearchDialog - Dialog for searching in Forms/Tables
-// ===================================================================================================
-
 struct FmSearchProgress;
 
 class FmSearchEngine;
 
+/// Dialog for searching in Forms/Tables
 class FmSearchDialog : public ModalDialog
 {
     friend class FmSearchEngine;
@@ -97,18 +94,18 @@ class FmSearchDialog : public ModalDialog
 
     Window*         m_pPreSearchFocus;
 
-    Link    m_lnkFoundHandler;          // Handler for "found"
-    Link    m_lnkCanceledNotFoundHdl;   // Handler for Positioning the Cursors
+    Link    m_lnkFoundHandler;          ///< Handler for "found"
+    Link    m_lnkCanceledNotFoundHdl;   ///< Handler for Positioning the Cursors
 
-    Link    m_lnkContextSupplier;       // for search in contexts
+    Link    m_lnkContextSupplier;       ///< for search in contexts
 
-    // memorize the currently selected field for every context
+    /// memorize the currently selected field for every context
     ::std::vector<String> m_arrContextFields;
 
     FmSearchEngine* m_pSearchEngine;
 
     Timer           m_aDelayedPaint;
-        // see EnableSearchUI
+    // see EnableSearchUI
 
     ::svxform::FmSearchConfigItem*      m_pConfig;
 public:
@@ -153,18 +150,16 @@ protected:
     virtual sal_Bool Close();
 
     void Init(const String& strVisibleFields, const String& strInitialText);
-        // only to be used out of the constructors
+    // only to be used out of the constructors
 
     void OnFound(const ::com::sun::star::uno::Any& aCursorPos, sal_Int16 nFieldPos);
-
-    void EnableSearchUI(sal_Bool bEnable);
-
-    /*  When searching in an own thread I naturally want to disable the UI for starting the search and for setting search
-        parameters. If bEnalbe == sal_False, for all affected controls painting is turned off and shortly after turned on
+    /** When searching in an own thread I naturally want to disable the UI for starting the search and for setting search
+        parameters. If bEnable == sal_False, for all affected controls painting is turned off and shortly after turned on
         again using m_aDelayedPaint. If there is a demand with bEnable == sal_True inbetween, the timer is stopped and
         painting is turned on immediately. As a consequence for this intricateness there is no flickering when turning
         off and on quickly.
     */
+    void EnableSearchUI(sal_Bool bEnable);
 
     void EnableSearchForDependees(sal_Bool bEnable);
 
@@ -192,8 +187,7 @@ private:
 
     DECL_LINK( OnSearchProgress, FmSearchProgress* );
 
-    DECL_LINK( OnDelayedPaint, void* );
-        // see EnableSearchUI
+    DECL_LINK( OnDelayedPaint, void* ); ///< see EnableSearchUI
 
     void implMoveControls(Control** _ppControls, sal_Int32 _nControls, sal_Int32 _nUp, Control* _pToResize);
 

cui/source/inc/cuihyperdlg.hxx

@@ -61,7 +61,7 @@ public :
 class SvxHpLinkDlg : public IconChoiceDialog
 {
 private:
-    SvxHlinkCtrl        maCtrl;         // Controler
+    SvxHlinkCtrl        maCtrl;         ///< Controler
     SfxBindings*        mpBindings;
     SfxItemSet*         mpItemSet;
 

cui/source/inc/cuitabarea.hxx

@@ -125,7 +125,7 @@ class SvxTransparenceTabPage : public SvxTabPage
     RadioButton         aRbtTransLinear;
     RadioButton         aRbtTransGradient;
 
-    // linear transparency
+    /// linear transparency
     MetricField         aMtrTransparent;
 
     // gradient transparency
@@ -646,7 +646,7 @@ public:
     virtual Window* GetParentLabeledBy( const Window* pLabeled ) const;
 };
 
-// Load save embed functionality
+/// Load save embed functionality
 class SvxLoadSaveEmbed {
     XPropertyListType   meType;
     XOutdevItemPool*    mpXPool;

cui/source/inc/cuitabline.hxx

@@ -126,12 +126,16 @@ private:
     LineEndLB           maLBEdgeStyle;
 
     //#58425# symbols on a line (e. g. StarChart) ->
-    SdrObjList*         pSymbolList; //a list of symbols to be shown in menu. Symbol at position SID_ATTR_SYMBOLTYPE is to be shown in preview. The list position is to be used cyclic.
+    /** a list of symbols to be shown in menu. Symbol at position SID_ATTR_SYMBOLTYPE is to be shown in preview.
+        The list position is to be used cyclic. */
+    SdrObjList*         pSymbolList;
     bool                bNewSize;
-    Graphic             aAutoSymbolGraphic; //a graphic to be displayed in the preview in case that an automatic symbol is choosen
+    /// a graphic to be displayed in the preview in case that an automatic symbol is choosen
+    Graphic             aAutoSymbolGraphic;
     long                nNumMenuGalleryItems;
     long                nSymbolType;
-    SfxItemSet*         pSymbolAttr; //attributes for the shown symbols; only necessary if not equal to line properties
+    /// attributes for the shown symbols; only necessary if not equal to line properties
+    SfxItemSet*         pSymbolAttr;
     FixedLine           aFlSymbol;
     MenuButton          aSymbolMB;
     FixedText           aSymbolWidthFT;

cui/source/inc/dlgname.hxx

@@ -37,11 +37,7 @@
 // #i68101#
 #include <svtools/svmedit.hxx>
 
-/*************************************************************************
-|*
-|* Dialog zum Editieren eines Namens
-|*
-\************************************************************************/
+/// Dialog for editing a name
 class SvxNameDialog : public ModalDialog
 {
 private:
@@ -86,11 +82,9 @@ public:
     void    SetEditHelpId( const rtl::OString& aHelpId) {aEdtName.SetHelpId(aHelpId);}
 };
 
-///////////////////////////////////////////////////////////////////////////////////////////////
-// #i68101#
-// Dialog for editing Object Title and Description
-// plus uniqueness-callback-linkHandler
-
+/** #i68101#
+    Dialog for editing Object Title and Description
+    plus uniqueness-callback-linkHandler */
 class SvxObjectNameDialog : public ModalDialog
 {
 private:
@@ -131,10 +125,8 @@ public:
     }
 };
 
-///////////////////////////////////////////////////////////////////////////////////////////////
-// #i68101#
-// Dialog for editing Object Title and Description
-
+/** #i68101#
+    Dialog for editing Object Title and Description */
 class SvxObjectTitleDescDialog : public ModalDialog
 {
 private:
@@ -163,13 +155,7 @@ public:
     void GetDescription(String& rDescription) {rDescription = aEdtDescription.GetText(); }
 };
 
-///////////////////////////////////////////////////////////////////////////////////////////////
-
-/*************************************************************************
-|*
-|* Dialog zum Abbrechen, Speichern oder Hinzufuegen
-|*
-\************************************************************************/
+/// Dialog to cancel, save, or add
 class SvxMessDialog : public ModalDialog
 {
 private:

cui/source/inc/hangulhanjadlg.hxx

@@ -136,11 +136,11 @@ namespace svx
         CheckBox        m_aReplaceByChar;
 
         CheckBox*       m_pIgnoreNonPrimary;
+        /** are we working for a document? This is normally true, but in case
+            the user uses the "find" functionality, we switch to working
+            with what the user entered, which then does not have any relation to
+            the document anymore. Some functionality must be disabled then */
         bool            m_bDocumentMode;
-                            // are we working for a document? This is normally true, but in case
-                            // the user uses the "find" functionality, we switch to working
-                            // with what the user entered, which then does not have any relation to
-                            // the document anymore. Some functionality must be disabled then
 
         Link            m_aOptionsChangedLink;
         Link            m_aClickByCharacterLink;
@@ -171,7 +171,7 @@ namespace svx
 
         void    FocusSuggestion( );
 
-        // retrieves the current suggestion
+        /// retrieves the current suggestion
         String  GetCurrentSuggestion( ) const;
 
         void        SetConversionFormat( editeng::HangulHanjaConversion::ConversionFormat _eType );
@@ -180,14 +180,14 @@ namespace svx
         void            SetByCharacter( sal_Bool _bByCharacter );
         void            SetConversionDirectionState( sal_Bool _bTryBothDirections, editeng::HangulHanjaConversion::ConversionDirection _ePrimaryConversionDirection );
 
-        // should text which does not match the primary conversion direction be ignored?
+        /// should text which does not match the primary conversion direction be ignored?
         sal_Bool        GetUseBothDirections( ) const;
 
-        // get current conversion direction to use
-        // (return argument if GetUseBothDirections is true)
+        /** get current conversion direction to use
+            (return argument if GetUseBothDirections is true) */
         editeng::HangulHanjaConversion::ConversionDirection GetDirection( editeng::HangulHanjaConversion::ConversionDirection eDefaultDirection ) const;
 
-        // enables or disbales the checkboxes for ruby formatted replacements
+        /// enables or disbales the checkboxes for ruby formatted replacements
         void            EnableRubySupport( sal_Bool bVal );
 
     private:
@@ -198,7 +198,7 @@ namespace svx
         DECL_LINK( OnConversionDirectionClicked, CheckBox* );
         DECL_LINK( ClickByCharacterHdl, CheckBox* );
 
-        // fill the suggestion list box with suggestions for the actual input
+        /// fill the suggestion list box with suggestions for the actual input
         void FillSuggestions( const ::com::sun::star::uno::Sequence< ::rtl::OUString >& _rSuggestions );
     };
 
@@ -235,7 +235,7 @@ namespace svx
         DECL_LINK( EditDictHdl, void* );
         DECL_LINK( DeleteDictHdl, void* );
 
-        void                Init( void );       // reads settings from core and init controls
+        void                Init( void );       ///< reads settings from core and init controls
     public:
                             HangulHanjaOptionsDialog( Window* _pParent );
         virtual             ~HangulHanjaOptionsDialog();

cui/source/inc/headertablistbox.hxx

@@ -39,11 +39,10 @@ public:
     inline SvHeaderTabListBox&  GetListBox( void );
     inline HeaderBar&           GetHeaderBar( void );
 
-    void                        ConnectElements( void );
-                                    // should be called after all manipulations on elements are done
-                                    // calcs real sizes depending on sizes of this
-    void                        Show( sal_Bool bVisible = sal_True, sal_uInt16 nFlags = 0 );    // same meaning as Windows::Show()
-    void                        Enable( bool bEnable = true, bool bChild = true );  // same meaning as Windows::Enable()
+    void                        ConnectElements( void );/**< should be called after all manipulations on elements are done
+                                                             calcs real sizes depending on sizes of this */
+    void                        Show( sal_Bool bVisible = sal_True, sal_uInt16 nFlags = 0 );    ///< same meaning as Windows::Show()
+    void                        Enable( bool bEnable = true, bool bChild = true );  ///< same meaning as Windows::Enable()
 };
 
 inline SvHeaderTabListBox& _HeaderTabListBox::GetListBox( void )

cui/source/inc/hldoctp.hxx

@@ -58,12 +58,12 @@ private:
     DECL_LINK (ClickFileopenHdl_Impl  , void * );
     DECL_LINK (ClickTargetHdl_Impl    , void * );
 
-    DECL_LINK (ModifiedPathHdl_Impl  , void * ); // Contens of combobox "Path" modified
-    DECL_LINK (ModifiedTargetHdl_Impl, void * ); // Contens of editfield "Target" modified
+    DECL_LINK (ModifiedPathHdl_Impl  , void * ); ///< Contens of combobox "Path" modified
+    DECL_LINK (ModifiedTargetHdl_Impl, void * ); ///< Contens of editfield "Target" modified
 
-    DECL_LINK (LostFocusPathHdl_Impl,  void * ); // Combobox "path" lost its focus
+    DECL_LINK (LostFocusPathHdl_Impl,  void * ); ///< Combobox "path" lost its focus
 
-    DECL_LINK(TimeoutHdl_Impl      , void *);   // Handler for timer -timeout
+    DECL_LINK(TimeoutHdl_Impl      , void *);  ///< Handler for timer -timeout
 
     enum EPathType { Type_Unknown, Type_Invalid,
                      Type_ExistsFile, Type_File,

cui/source/inc/hlinettp.hxx

@@ -59,15 +59,15 @@ private:
 
     sal_Bool                mbMarkWndOpen;
 
-    DECL_LINK (Click_SmartProtocol_Impl  , void * );        // Radiobutton clicked: Type HTTP or FTP
-    DECL_LINK (ClickAnonymousHdl_Impl    , void * );        // Checkbox : Anonymous User
-    DECL_LINK (ClickBrowseHdl_Impl       , void * );        // Button : Browse
-    DECL_LINK (ClickTargetHdl_Impl       , void * );        // Button : Target
-    DECL_LINK (ModifiedLoginHdl_Impl     , void * );        // Contens of editfield "Login" modified
-    DECL_LINK (LostFocusTargetHdl_Impl   , void * );        // Combobox "Target" lost its focus
-    DECL_LINK (ModifiedTargetHdl_Impl    , void * );        // Contens of editfield "Target" modified
-
-    DECL_LINK(TimeoutHdl_Impl           , void *);       // Handler for timer -timeout
+    DECL_LINK (Click_SmartProtocol_Impl  , void * ); ///< Radiobutton clicked: Type HTTP or FTP
+    DECL_LINK (ClickAnonymousHdl_Impl    , void * ); ///< Checkbox : Anonymous User
+    DECL_LINK (ClickBrowseHdl_Impl       , void * ); ///< Button : Browse
+    DECL_LINK (ClickTargetHdl_Impl       , void * ); ///< Button : Target
+    DECL_LINK (ModifiedLoginHdl_Impl     , void * ); ///< Contens of editfield "Login" modified
+    DECL_LINK (LostFocusTargetHdl_Impl   , void * ); ///< Combobox "Target" lost its focus
+    DECL_LINK (ModifiedTargetHdl_Impl    , void * ); ///< Contens of editfield "Target" modified
+
+    DECL_LINK(TimeoutHdl_Impl           , void *); ///< Handler for timer -timeout
 
 
     void    SetScheme( const String& aScheme );

cui/source/inc/hlmailtp.hxx

@@ -39,9 +39,9 @@ private:
     FixedText           maFtSubject;
     Edit                maEdSubject;
 
-    DECL_LINK (Click_SmartProtocol_Impl, void * );      // Radiobutton clicked: Type EMAIl or News
-    DECL_LINK (ClickAdrBookHdl_Impl  , void * );        // Button : Address book
-    DECL_LINK (ModifiedReceiverHdl_Impl, void * );      // Combobox "receiver" modified
+    DECL_LINK (Click_SmartProtocol_Impl, void * ); ///< Radiobutton clicked: Type EMAIl or News
+    DECL_LINK (ClickAdrBookHdl_Impl  , void * ); ///< Button : Address book
+    DECL_LINK (ModifiedReceiverHdl_Impl, void * ); ///< Combobox "receiver" modified
 
     void    SetScheme( const String& aScheme );
     void    RemoveImproperProtocol(const String& aProperScheme);

cui/source/inc/hltpbase.hxx

@@ -55,13 +55,7 @@
 #include "hlmarkwn.hxx"
 #include "iconcdlg.hxx"
 
-
-/*************************************************************************
-|*
-|* ComboBox-Control, wich is filled with all current framenames
-|*
-\************************************************************************/
-
+/// ComboBox-Control, wich is filled with all current framenames
 class SvxFramesComboBox : public ComboBox
 {
 public:
@@ -69,12 +63,7 @@ public:
     ~SvxFramesComboBox ();
 };
 
-/*************************************************************************
-|*
-|* ComboBox-Control for URL's with History and Autocompletion
-|*
-\************************************************************************/
-
+/// ComboBox-Control for URL's with History and Autocompletion
 class SvxHyperURLBox : public SvtURLBox, public DropTargetHelper
 {
 private:
@@ -94,12 +83,7 @@ public:
 
 };
 
-/*************************************************************************
-|*
-|* Tabpage : Basisclass
-|*
-\************************************************************************/
-
+/// Tabpage : Basisclass
 class SvxHyperlinkTabPageBase : public IconChoicePage
 {
 private:
@@ -142,7 +126,7 @@ protected:
                                           String& aStrIntName, String& aStrFrame,
                                           SvxLinkInsertMode& eMode );
 
-    DECL_LINK (ClickScriptHdl_Impl, void * );       // Button : Script
+    DECL_LINK (ClickScriptHdl_Impl, void * ); ///< Button : Script
 
     String              aEmptyStr;
 

cui/source/inc/iconcdlg.hxx

@@ -55,20 +55,15 @@ typedef sal_uInt16*         (*GetPageRanges)(); // gives international Which-val
 // position of iconchoicectrl
 enum EIconChoicePos { PosLeft, PosRight, PosTop, PosBottom };
 
-/**********************************************************************
-|
-| Data-structure for pages in dialog
-|
-\**********************************************************************/
-
+/// Data-structure for pages in dialog
 struct IconChoicePageData
 {
     sal_uInt16 nId;
-    CreatePage fnCreatePage;    // pointer to the factory
-    GetPageRanges fnGetRanges;  // pointer to the ranges-function
-    IconChoicePage* pPage;      // the TabPage itself
-    sal_Bool bOnDemand;         // Flag: ItemSet onDemand
-    sal_Bool bRefresh;          // Flag: page has to be newly initialized
+    CreatePage fnCreatePage;    ///< pointer to the factory
+    GetPageRanges fnGetRanges;  ///< pointer to the ranges-function
+    IconChoicePage* pPage;      ///< the TabPage itself
+    sal_Bool bOnDemand;         ///< Flag: ItemSet onDemand
+    sal_Bool bRefresh;          ///< Flag: page has to be newly initialized
 
     // constructor
     IconChoicePageData( sal_uInt16 Id, CreatePage fnPage, GetPageRanges fnRanges, sal_Bool bDemand )
@@ -81,12 +76,6 @@ struct IconChoicePageData
     {}
 };
 
-/**********************************************************************
-|
-| IconChoicePage
-|
-\**********************************************************************/
-
 class IconChoicePage : public TabPage
 {
     using TabPage::ActivatePage;
@@ -124,11 +113,11 @@ public :
     void                SetExchangeSupport( sal_Bool bNew = sal_True )  { bHasExchangeSupport = bNew; }
 
     enum {
-        KEEP_PAGE = 0x0000,     // error handling
-            // 2nd filling of an ItemSet for updating superior examples;
-            // this pointer can always be NULL!!
+        KEEP_PAGE = 0x0000, ///< error handling
+        /** 2nd filling of an ItemSet for updating superior examples;
+            this pointer can always be NULL!! */
         LEAVE_PAGE = 0x0001,
-            // refresh set and update other pages
+        /// refresh set and update other pages
         REFRESH_SET = 0x0002
     };
 
@@ -144,12 +133,6 @@ public :
     void                DataChanged( const DataChangedEvent& rDCEvt );
 };
 
-/**********************************************************************
-|
-| IconChoiceDialog
-|
-\**********************************************************************/
-
 class IconChoiceDialog : public ModalDialog
 {
 private :
@@ -215,21 +198,14 @@ protected :
 public :
 
     // the IconChoiceCtrl's could also be set in the Ctor
-
     IconChoiceDialog ( Window* pParent, const ResId &rResId,
                        const EIconChoicePos ePos = PosLeft, const SfxItemSet * pItemSet = 0 );
     ~IconChoiceDialog ();
 
-    ///////////////////////////////////////////////////////////////////////////////////
-    // virtual methods
-    //
     virtual void        Paint( const Rectangle& rRect );
     virtual void        Resize();
 
-    ///////////////////////////////////////////////////////////////////////////////////
     // interface
-    //
-
     SvxIconChoiceCtrlEntry* AddTabPage(
         sal_uInt16 nId, const String& rIconText, const Image& rChoiceIcon,
         CreatePage pCreateFunc /* != NULL */, GetPageRanges pRangesFunc = NULL /* NULL allowed*/,
@@ -239,8 +215,8 @@ public :
     sal_uInt16              GetCurPageId() const       { return mnCurrentPageId; }
     void                ShowPage( sal_uInt16 nId );
 
-                        // gives via map converted local slots if applicable
-    const sal_uInt16*       GetInputRanges( const SfxItemPool& );
+    /// gives via map converted local slots if applicable
+    const sal_uInt16*   GetInputRanges( const SfxItemPool& );
     void                SetInputSet( const SfxItemSet* pInSet );
     const SfxItemSet*   GetOutputItemSet() const { return pOutSet; }
 

cui/source/inc/insdlg.hxx

@@ -94,12 +94,10 @@ public:
                             const SvObjectServerList* pServers = NULL );
     virtual short       Execute();
 
-    // get replacement for the iconified embedded object and the mediatype of the replacement
+    /// get replacement for the iconified embedded object and the mediatype of the replacement
     ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > GetIconIfIconified( ::rtl::OUString* pGraphicMediaType );
 };
 
-// class SvInsertPlugInDialog --------------------------------------------
-
 class SvInsertPlugInDialog : public InsertObjectDialog_Impl
 {
 private:

cui/source/inc/labdlg.hxx

@@ -125,7 +125,7 @@ public:
 
             ~SvxCaptionTabDialog();
 
-            //link for the Writer to validate positions
+            /// link for the Writer to validate positions
             void SetValidateFramePosLink( const Link& rLink );
 };
 

cui/source/inc/measure.hxx

@@ -36,12 +36,7 @@
 
 class SdrView;
 
-/*************************************************************************
-|*
-|* Dialog for changing TextAtrributes
-|*
-\************************************************************************/
-
+/// Dialog for changing TextAtrributes
 class SvxMeasurePage : public SvxTabPage
 {
 private:
@@ -106,13 +101,8 @@ public:
     virtual void PageCreated (SfxAllItemSet aSet);
 };
 
-/*************************************************************************
-|*
-|* Derived from SfxSingleTabDialog, in order to be able to be
-|* informed about virtual methods by the control.
-|*
-\************************************************************************/
-
+/* Derived from SfxSingleTabDialog, in order to be able to be
+   informed about virtual methods by the control. */
 class SvxMeasureDialog : public SfxSingleTabDialog
 {
 public:

cui/source/inc/numfmt.hxx

@@ -82,9 +82,9 @@ public:
 
     static SfxTabPage*      Create( Window* pParent,
                                     const SfxItemSet& rAttrSet );
-    static sal_uInt16*          GetRanges();
+    static sal_uInt16*      GetRanges();
 
-    virtual sal_Bool            FillItemSet( SfxItemSet& rSet );
+    virtual sal_Bool        FillItemSet( SfxItemSet& rSet );
     virtual void            Reset( const SfxItemSet& rSet );
     virtual int             DeactivatePage  ( SfxItemSet* pSet = NULL );
 
@@ -129,11 +129,11 @@ private:
 
     SvxNumberInfoItem*      pNumItem;
     SvxNumberFormatShell*   pNumFmtShell;
-    sal_uLong                   nInitFormat;
+    sal_uLong               nInitFormat;
     Link                    fnOkHdl;
 
-    sal_Bool                    bNumItemFlag; // for handling with DocShell
-    sal_Bool                    bOneAreaFlag;
+    sal_Bool                bNumItemFlag; ///< for handling with DocShell
+    sal_Bool                bOneAreaFlag;
     short                   nFixedCategory;
 
     long                    nCatHeight;

cui/source/inc/numpages.hxx

@@ -135,10 +135,9 @@ class SvxBulletPickTabPage : public SfxTabPage
     virtual void        PageCreated(SfxAllItemSet aSet);
 };
 
-/*--------------------------------------------------
-    TabPage for complete numeration
---------------------------------------------------*/
 #define NUM_VALUSET_COUNT 16
+
+/// TabPage for complete numeration
 class SvxNumPickTabPage : public SfxTabPage
 {
     using TabPage::ActivatePage;
@@ -298,6 +297,10 @@ class SvxNumOptionsTabPage : public SfxTabPage
     SfxMapUnit          eCoreUnit;
 
     void                InitControls();
+    /** To switch between the numbering type
+        0 - Number;
+        1 - Bullet;
+        2 - Bitmap; */
     void                SwitchNumberType( sal_uInt8 nType, sal_Bool bBmp = sal_False );
     void                CheckForStartValue_Impl(sal_uInt16 nNumberingType);