[Libreoffice-commits] core.git: vcl/inc
Nourah.AlShoeibi
nourah.alshoeibi at gmail.com
Thu Jul 11 06:32:58 PDT 2013
vcl/inc/cupsmgr.hxx | 14 +++----
vcl/inc/fontsubset.hxx | 26 ++++++-------
vcl/inc/ilstbox.hxx | 94 +++++++++++++++++++++++------------------------
vcl/inc/impimagetree.hxx | 8 ++--
vcl/inc/printdlg.hxx | 4 +-
5 files changed, 73 insertions(+), 73 deletions(-)
New commits:
commit 00a26f824232d9dbf68cfbcbdd4b423da23ed4eb
Author: Nourah.AlShoeibi <nourah.alshoeibi at gmail.com>
Date: Thu Jul 11 12:03:19 2013 +0300
Modifying comments to meet Doxygen standards
Change-Id: I5f69285d571c08c40f2e8a7495363a7b97bbadb3
Reviewed-on: https://gerrit.libreoffice.org/4825
Reviewed-by: Petr Mladek <pmladek at suse.cz>
Tested-by: Petr Mladek <pmladek at suse.cz>
diff --git a/vcl/inc/cupsmgr.hxx b/vcl/inc/cupsmgr.hxx
index 9a84b77..ac040b0 100644
--- a/vcl/inc/cupsmgr.hxx
+++ b/vcl/inc/cupsmgr.hxx
@@ -47,9 +47,9 @@ class CUPSManager : public PrinterInfoManager
boost::unordered_map< OUString, PPDContext, OUStringHash > m_aDefaultContexts;
OString m_aUser;
- // this is a security risk, but the CUPS API demands
- // to deliver a pointer to a static buffer containing
- // the password, so this cannot be helped
+ /** this is a security risk, but the CUPS API demands
+ to deliver a pointer to a static buffer containing
+ the password, so this cannot be helped*/
OString m_aPassword;
osl::Mutex m_aCUPSMutex;
@@ -67,13 +67,13 @@ class CUPSManager : public PrinterInfoManager
void runDests();
OString threadedCupsGetPPD(const char* pPrinter);
public:
- // public for stub
+ /// public for stub
static void runDestThread(void* pMgr);
static CUPSManager* tryLoadCUPS();
+ /// wraps cupsGetPPD, so unlink after use !
const PPDParser* createCUPSParser( const OUString& rPrinter );
- // wraps cupsGetPPD, so unlink after use !
const char* authenticateUser( const char* );
@@ -81,10 +81,10 @@ public:
virtual int endSpool( const OUString& rPrinterName, const OUString& rJobTitle, FILE* pFile, const JobData& rDocumentJobData, bool bBanner );
virtual void setupJobContextData( JobData& rData );
- // changes the info about a named printer
+ /// changes the info about a named printer
virtual void changePrinterInfo( const OUString& rPrinter, const PrinterInfo& rNewInfo );
- // check if the printer configuration has changed
+ /// check if the printer configuration has changed
virtual bool checkPrintersChanged( bool bWait );
// members for administration (->padmin)
diff --git a/vcl/inc/fontsubset.hxx b/vcl/inc/fontsubset.hxx
index eeb920b..b5f62f2 100644
--- a/vcl/inc/fontsubset.hxx
+++ b/vcl/inc/fontsubset.hxx
@@ -26,7 +26,7 @@
#include "vcl/dllapi.h"
-namespace vcl { struct _TrueTypeFont; } // SFT's idea of a TTF font
+namespace vcl { struct _TrueTypeFont; } ///< SFT's idea of a TTF font
class VCL_DLLPUBLIC FontSubsetInfo
{
@@ -36,13 +36,13 @@ public:
enum FontType {
NO_FONT = 0,
- SFNT_TTF = 1<<1, // SFNT container with TrueType glyphs
- SFNT_CFF = 1<<2, // SFNT container with CFF-container
- TYPE1_PFA = 1<<3, // PSType1 Postscript Font Ascii
- TYPE1_PFB = 1<<4, // PSType1 Postscript Font Binary
- CFF_FONT = 1<<5, // CFF-container with PSType2 glyphs
- TYPE3_FONT = 1<<6, // PSType3 Postscript font
- TYPE42_FONT = 1<<7, // PSType42 wrapper for an SFNT_TTF
+ SFNT_TTF = 1<<1, ///< SFNT container with TrueType glyphs
+ SFNT_CFF = 1<<2, ///< SFNT container with CFF-container
+ TYPE1_PFA = 1<<3, ///< PSType1 Postscript Font Ascii
+ TYPE1_PFB = 1<<4, ///< PSType1 Postscript Font Binary
+ CFF_FONT = 1<<5, ///< CFF-container with PSType2 glyphs
+ TYPE3_FONT = 1<<6, ///< PSType3 Postscript font
+ TYPE42_FONT = 1<<7, ///< PSType42 wrapper for an SFNT_TTF
ANY_SFNT = SFNT_TTF | SFNT_CFF,
ANY_TYPE1 = TYPE1_PFA | TYPE1_PFB,
ANY_FONT = 0xFF
@@ -58,23 +58,23 @@ public:
int nReqGlyphCount, sal_Int32* pOutGlyphWidths = NULL );
public: // TODO: make subsetter results private and provide accessor methods instead
- // subsetter-provided subset details needed by e.g. Postscript or PDF
+ // subsetter-provided subset details needed by e.g. Postscript or PDF
String m_aPSName;
- int m_nAscent; // all metrics in PS font units
+ int m_nAscent; ///< all metrics in PS font units
int m_nDescent;
int m_nCapHeight;
Rectangle m_aFontBBox;
- FontType m_nFontType; // font-type of subset result
+ FontType m_nFontType; ///< font-type of subset result
private:
// input-font-specific details
unsigned const char* mpInFontBytes;
int mnInByteLength;
- FontType meInFontType; // allowed mask of input font-types
+ FontType meInFontType; ///< allowed mask of input font-types
vcl::_TrueTypeFont* mpSftTTFont;
// subset-request details
- int mnReqFontTypeMask; // allowed subset-target font types
+ int mnReqFontTypeMask; ///< allowed subset-target font types
FILE* mpOutFile;
const char* mpReqFontName;
const long* mpReqGlyphIds;
diff --git a/vcl/inc/ilstbox.hxx b/vcl/inc/ilstbox.hxx
index 8962c1d..89e2db0 100644
--- a/vcl/inc/ilstbox.hxx
+++ b/vcl/inc/ilstbox.hxx
@@ -100,7 +100,7 @@ struct ImplEntryType
class ImplEntryList
{
private:
- Window* mpWindow; // For getting the current locale when matching strings
+ Window* mpWindow; ///< For getting the current locale when matching strings
sal_uInt16 mnLastSelected;
sal_uInt16 mnSelectionAnchor;
sal_uInt16 mnImages;
@@ -133,10 +133,10 @@ public:
sal_uInt16 FindEntry( const XubString& rStr, sal_Bool bSearchMRUArea = sal_False ) const;
sal_uInt16 FindEntry( const void* pData ) const;
- // helper: add up heights up to index nEndIndex.
- // GetAddedHeight( 0 ) returns 0
- // GetAddedHeight( LISTBOX_ENTRY_NOTFOUND ) returns 0
- // GetAddedHeight( i, k ) with k > i is equivalent -GetAddedHeight( k, i )
+ /// helper: add up heights up to index nEndIndex.
+ /// GetAddedHeight( 0 ) @return 0
+ /// GetAddedHeight( LISTBOX_ENTRY_NOTFOUND ) @return 0
+ /// GetAddedHeight( i, k ) with k > i is equivalent -GetAddedHeight( k, i )
long GetAddedHeight( sal_uInt16 nEndIndex, sal_uInt16 nBeginIndex = 0, long nBeginHeight = 0 ) const;
long GetEntryHeight( sal_uInt16 nPos ) const;
@@ -181,7 +181,7 @@ public:
LISTBOX_ENTRY_FLAG_DISABLE_SELECTION flag set. */
bool IsEntrySelectable( sal_uInt16 nPos ) const;
- /** returns the first entry found from the given position nPos that is selectable
+ /** @return the first entry found from the given position nPos that is selectable
or LISTBOX_ENTRY_NOTFOUND if non is found. If the entry at nPos is not selectable,
it returns the first selectable entry after nPos if bForward is true and the
first selectable entry after nPos is bForward is false.
@@ -196,55 +196,55 @@ public:
class ImplListBoxWindow : public Control, public ::vcl::ISearchableStringList
{
private:
- ImplEntryList* mpEntryList; // EntryList
+ ImplEntryList* mpEntryList; ///< EntryList
Rectangle maFocusRect;
Size maUserItemSize;
- long mnMaxTxtHeight; // Maximum height of a text item
- long mnMaxTxtWidth; // Maximum width of a text item
- // Entry without Image
- long mnMaxImgTxtWidth;// Maximum width of a text item
- // Entry AND Image
- long mnMaxImgWidth; // Maximum width of an image item
- long mnMaxImgHeight; // Maximum height of an image item
- long mnMaxWidth; // Maximum width of an entry
- long mnMaxHeight; // Maximum height of an entry
+ long mnMaxTxtHeight; ///< Maximum height of a text item
+ long mnMaxTxtWidth; ///< Maximum width of a text item
+ ///< Entry without Image
+ long mnMaxImgTxtWidth;///< Maximum width of a text item
+ ///< Entry AND Image
+ long mnMaxImgWidth; ///< Maximum width of an image item
+ long mnMaxImgHeight; ///< Maximum height of an image item
+ long mnMaxWidth; ///< Maximum width of an entry
+ long mnMaxHeight; ///< Maximum height of an entry
- sal_uInt16 mnCurrentPos; // Position (Focus)
- sal_uInt16 mnTrackingSaveSelection; // Selection before Tracking();
+ sal_uInt16 mnCurrentPos; ///< Position (Focus)
+ sal_uInt16 mnTrackingSaveSelection; ///< Selection before Tracking();
- sal_uInt16 mnSeparatorPos; // Separator
+ sal_uInt16 mnSeparatorPos; ///< Separator
sal_uInt16 mnUserDrawEntry;
- sal_uInt16 mnTop; // output from line on
- long mnLeft; // output from column on
- long mnBorder; // distance border - text
- long mnTextHeight; // text height
- ProminentEntry meProminentType; // where is the "prominent" entry
+ sal_uInt16 mnTop; ///< output from line on
+ long mnLeft; ///< output from column on
+ long mnBorder; ///< distance border - text
+ long mnTextHeight; ///< text height
+ ProminentEntry meProminentType; ///< where is the "prominent" entry
- sal_uInt16 mnSelectModifier; // Modifiers
+ sal_uInt16 mnSelectModifier; ///< Modifiers
/// bitfield
bool mbHasFocusRect : 1;
- bool mbSort : 1; // ListBox sorted
- bool mbTrack : 1; // Tracking
- bool mbMulti : 1; // MultiListBox
- bool mbStackMode : 1; // StackSelection
- bool mbSimpleMode : 1; // SimpleMode for MultiListBox
- bool mbImgsDiffSz : 1; // Images have different sizes
- bool mbTravelSelect : 1; // TravelSelect
- bool mbTrackingSelect : 1; // Selected at a MouseMove
- bool mbSelectionChanged : 1; // Do not call Select() too often ...
- bool mbMouseMoveSelect : 1; // Select at MouseMove
- bool mbGrabFocus : 1; // Grab focus at MBDown
- bool mbUserDrawEnabled : 1; // UserDraw possible
- bool mbInUserDraw : 1; // In UserDraw
- bool mbReadOnly : 1; // ReadOnly
- bool mbMirroring : 1; // pb: #106948# explicit mirroring for calc
- bool mbRight : 1; // right align Text output
- bool mbCenter : 1; // center Text output
+ bool mbSort : 1; ///< ListBox sorted
+ bool mbTrack : 1; ///< Tracking
+ bool mbMulti : 1; ///< MultiListBox
+ bool mbStackMode : 1; ///< StackSelection
+ bool mbSimpleMode : 1; ///< SimpleMode for MultiListBox
+ bool mbImgsDiffSz : 1; ///< Images have different sizes
+ bool mbTravelSelect : 1; ///< TravelSelect
+ bool mbTrackingSelect : 1; ///< Selected at a MouseMove
+ bool mbSelectionChanged : 1; ///< Do not call Select() too often ...
+ bool mbMouseMoveSelect : 1; ///< Select at MouseMove
+ bool mbGrabFocus : 1; ///< Grab focus at MBDown
+ bool mbUserDrawEnabled : 1; ///< UserDraw possible
+ bool mbInUserDraw : 1; ///< In UserDraw
+ bool mbReadOnly : 1; ///< ReadOnly
+ bool mbMirroring : 1; ///< pb: #106948# explicit mirroring for calc
+ bool mbRight : 1; ///< right align Text output
+ bool mbCenter : 1; ///< center Text output
bool mbEdgeBlending : 1;
Link maScrollHdl;
@@ -307,8 +307,8 @@ public:
void SetTopEntry( sal_uInt16 nTop );
sal_uInt16 GetTopEntry() const { return mnTop; }
- // ShowProminentEntry will set the entry correspoding to nEntryPos
- // either at top or in the middle depending on the chosen style
+ /** ShowProminentEntry will set the entry correspoding to nEntryPos
+ either at top or in the middle depending on the chosen style*/
void ShowProminentEntry( sal_uInt16 nEntryPos );
void SetProminentEntryType( ProminentEntry eType ) { meProminentType = eType; }
ProminentEntry GetProminentEntryType() const { return meProminentType; }
@@ -376,7 +376,7 @@ public:
void ImplInitSettings( sal_Bool bFont, sal_Bool bForeground, sal_Bool bBackground );
sal_uInt16 ImplGetTextStyle() const;
- // pb: #106948# explicit mirroring for calc
+ /// pb: #106948# explicit mirroring for calc
inline void EnableMirroring() { mbMirroring = true; }
inline bool IsMirroring() const { return mbMirroring; }
@@ -514,7 +514,7 @@ public:
bool GetEdgeBlending() const { return mbEdgeBlending; }
void SetEdgeBlending(bool bNew);
- // pb: #106948# explicit mirroring for calc
+ /// pb: #106948# explicit mirroring for calc
inline void EnableMirroring() { maLBWindow.EnableMirroring(); }
inline void SetDropTraget(const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& i_xDNDListenerContainer){ mxDNDListenerContainer= i_xDNDListenerContainer; }
};
@@ -570,7 +570,7 @@ class ImplWin : public Control
{
private:
- sal_uInt16 mnItemPos; // because of UserDraw I have to know which item I draw
+ sal_uInt16 mnItemPos; ///< because of UserDraw I have to know which item I draw
OUString maString;
Image maImage;
diff --git a/vcl/inc/impimagetree.hxx b/vcl/inc/impimagetree.hxx
index 11c003e..05f7ad0 100644
--- a/vcl/inc/impimagetree.hxx
+++ b/vcl/inc/impimagetree.hxx
@@ -42,7 +42,7 @@ public:
~ImplImageTree();
- // check whether the icon style is installed
+ /// check whether the icon style is installed
bool checkStyle(OUString const & style);
bool loadImage(
@@ -53,10 +53,10 @@ public:
OUString const & style,
BitmapEx& bitmap);
+/** a crude form of life cycle control (called from DeInitVCL; otherwise,
+ * if the ImplImageTree singleton were destroyed during exit that would
+ * be too late for the destructors of the bitmaps in m_iconCache)*/
void shutDown();
- // a crude form of life cycle control (called from DeInitVCL; otherwise,
- // if the ImplImageTree singleton were destroyed during exit that would
- // be too late for the destructors of the bitmaps in m_iconCache)
private:
bool doLoadImage(
diff --git a/vcl/inc/printdlg.hxx b/vcl/inc/printdlg.hxx
index f879a63..82476e7 100644
--- a/vcl/inc/printdlg.hxx
+++ b/vcl/inc/printdlg.hxx
@@ -128,7 +128,7 @@ namespace vcl
FixedText* mpNupOrderTxt;
ListBox* mpNupOrderBox;
ShowNupOrderWindow* mpNupOrderWin;
- // border around each page
+ /// border around each page
CheckBox* mpBorderCB;
void setupLayout();
@@ -215,7 +215,7 @@ namespace vcl
Size maNupPortraitSize;
Size maNupLandscapeSize;
- // internal, used for automatic Nup-Portrait/landscape
+ /// internal, used for automatic Nup-Portrait/landscape
Size maFirstPageSize;
OUString maPrintToFileText;
More information about the Libreoffice-commits
mailing list