diff options
author | Miklos Vajna <vmiklos@suse.cz> | 2012-11-07 09:12:24 +0100 |
---|---|---|
committer | Miklos Vajna <vmiklos@suse.cz> | 2012-11-07 09:13:17 +0100 |
commit | f510217832a6edaf6a44169cabdf739985d00125 (patch) | |
tree | af851d7abdc0329fa81c3565f0badbcd6c290727 /oox | |
parent | sal_Bool to bool (diff) | |
download | core-f510217832a6edaf6a44169cabdf739985d00125.tar.gz core-f510217832a6edaf6a44169cabdf739985d00125.zip |
oox: fix doxygen comments in helper
Change-Id: I1e9b2075cbbb7a2ad7de64dd449cb42bf95ecc20
Diffstat (limited to 'oox')
-rw-r--r-- | oox/inc/oox/helper/binaryinputstream.hxx | 6 | ||||
-rw-r--r-- | oox/inc/oox/helper/binaryoutputstream.hxx | 6 | ||||
-rw-r--r-- | oox/inc/oox/helper/binarystreambase.hxx | 10 | ||||
-rw-r--r-- | oox/inc/oox/helper/graphichelper.hxx | 16 | ||||
-rw-r--r-- | oox/inc/oox/helper/helper.hxx | 16 | ||||
-rw-r--r-- | oox/inc/oox/helper/modelobjecthelper.hxx | 26 | ||||
-rw-r--r-- | oox/inc/oox/helper/propertyset.hxx | 6 | ||||
-rw-r--r-- | oox/inc/oox/helper/storagebase.hxx | 14 | ||||
-rw-r--r-- | oox/inc/oox/helper/zipstorage.hxx | 2 |
9 files changed, 51 insertions, 51 deletions
diff --git a/oox/inc/oox/helper/binaryinputstream.hxx b/oox/inc/oox/helper/binaryinputstream.hxx index 0cd33b0ee068..aeadb4fac4bb 100644 --- a/oox/inc/oox/helper/binaryinputstream.hxx +++ b/oox/inc/oox/helper/binaryinputstream.hxx @@ -312,10 +312,10 @@ public: inline BinaryXInputStream& operator>>( Type& ornValue ) { readValue( ornValue ); return *this; } private: - StreamDataSequence maBuffer; /// Data buffer used in readMemory() function. + StreamDataSequence maBuffer; ///< Data buffer used in readMemory() function. ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > - mxInStrm; /// Reference to the input stream. - bool mbAutoClose; /// True = automatically close stream on destruction. + mxInStrm; ///< Reference to the input stream. + bool mbAutoClose; ///< True = automatically close stream on destruction. }; // ============================================================================ diff --git a/oox/inc/oox/helper/binaryoutputstream.hxx b/oox/inc/oox/helper/binaryoutputstream.hxx index d5ba0890e644..687008a6ffd1 100644 --- a/oox/inc/oox/helper/binaryoutputstream.hxx +++ b/oox/inc/oox/helper/binaryoutputstream.hxx @@ -143,10 +143,10 @@ public: getXOutputStream() const { return mxOutStrm; } private: - StreamDataSequence maBuffer; /// Data buffer used in writeMemory() function. + StreamDataSequence maBuffer; ///< Data buffer used in writeMemory() function. ::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream > - mxOutStrm; /// Reference to the output stream. - bool mbAutoClose; /// True = automatically close stream on destruction. + mxOutStrm; ///< Reference to the output stream. + bool mbAutoClose; ///< True = automatically close stream on destruction. }; // ============================================================================ diff --git a/oox/inc/oox/helper/binarystreambase.hxx b/oox/inc/oox/helper/binarystreambase.hxx index 44165f9bd71d..d9ab979de019 100644 --- a/oox/inc/oox/helper/binarystreambase.hxx +++ b/oox/inc/oox/helper/binarystreambase.hxx @@ -115,10 +115,10 @@ private: BinaryStreamBase& operator=( const BinaryStreamBase& ); protected: - bool mbEof; /// End of stream flag. + bool mbEof; ///< End of stream flag. private: - const bool mbSeekable; /// True = implementation supports seeking. + const bool mbSeekable; ///< True = implementation supports seeking. }; // ============================================================================ @@ -146,7 +146,7 @@ protected: private: ::com::sun::star::uno::Reference< ::com::sun::star::io::XSeekable > - mxSeekable; /// Stream seeking interface. + mxSeekable; ///< Stream seeking interface. }; // ============================================================================ @@ -174,8 +174,8 @@ protected: explicit SequenceSeekableStream( const StreamDataSequence& rData ); protected: - const StreamDataSequence* mpData; /// Wrapped data sequence. - sal_Int32 mnPos; /// Current position in the sequence. + const StreamDataSequence* mpData; ///< Wrapped data sequence. + sal_Int32 mnPos; ///< Current position in the sequence. }; // ============================================================================ diff --git a/oox/inc/oox/helper/graphichelper.hxx b/oox/inc/oox/helper/graphichelper.hxx index 9e350005c5a8..2c75a3e5084e 100644 --- a/oox/inc/oox/helper/graphichelper.hxx +++ b/oox/inc/oox/helper/graphichelper.hxx @@ -149,14 +149,14 @@ private: ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > mxContext; ::com::sun::star::uno::Reference< ::com::sun::star::graphic::XGraphicProvider > mxGraphicProvider; ::com::sun::star::uno::Reference< ::com::sun::star::awt::XUnitConversion > mxUnitConversion; - ::com::sun::star::awt::DeviceInfo maDeviceInfo; /// Current output device info. - SystemPalette maSystemPalette; /// Maps system colors (XML tokens) to RGB color values. - StorageRef mxStorage; /// Storage containing embedded graphics. - mutable GraphicObjectDeque maGraphicObjects; /// Caches all created graphic objects to keep them alive. - mutable EmbeddedGraphicMap maEmbeddedGraphics; /// Maps all embedded graphics by their storage path. - const ::rtl::OUString maGraphicObjScheme; /// The URL scheme name for graphic objects. - double mfPixelPerHmmX; /// Number of screen pixels per 1/100 mm in X direction. - double mfPixelPerHmmY; /// Number of screen pixels per 1/100 mm in Y direction. + ::com::sun::star::awt::DeviceInfo maDeviceInfo; ///< Current output device info. + SystemPalette maSystemPalette; ///< Maps system colors (XML tokens) to RGB color values. + StorageRef mxStorage; ///< Storage containing embedded graphics. + mutable GraphicObjectDeque maGraphicObjects; ///< Caches all created graphic objects to keep them alive. + mutable EmbeddedGraphicMap maEmbeddedGraphics; ///< Maps all embedded graphics by their storage path. + const ::rtl::OUString maGraphicObjScheme; ///< The URL scheme name for graphic objects. + double mfPixelPerHmmX; ///< Number of screen pixels per 1/100 mm in X direction. + double mfPixelPerHmmY; ///< Number of screen pixels per 1/100 mm in Y direction. }; // ============================================================================ diff --git a/oox/inc/oox/helper/helper.hxx b/oox/inc/oox/helper/helper.hxx index 12fed0d18c79..c4507844152a 100644 --- a/oox/inc/oox/helper/helper.hxx +++ b/oox/inc/oox/helper/helper.hxx @@ -85,9 +85,9 @@ const sal_uInt8 WINDOWS_CHARSET_OEM = 255; // ---------------------------------------------------------------------------- -const sal_Int32 API_RGB_TRANSPARENT = -1; /// Transparent color for API calls. -const sal_Int32 API_RGB_BLACK = 0x000000; /// Black color for API calls. -const sal_Int32 API_RGB_WHITE = 0xFFFFFF; /// White color for API calls. +const sal_Int32 API_RGB_TRANSPARENT = -1; ///< Transparent color for API calls. +const sal_Int32 API_RGB_BLACK = 0x000000; ///< Black color for API calls. +const sal_Int32 API_RGB_WHITE = 0xFFFFFF; ///< White color for API calls. const sal_Int16 API_LINE_SOLID = 0; const sal_Int16 API_LINE_DOTTED = 1; @@ -99,12 +99,12 @@ const sal_Int16 API_LINE_THIN = 35; const sal_Int16 API_LINE_MEDIUM = 88; const sal_Int16 API_LINE_THICK = 141; -const sal_Int16 API_ESCAPE_NONE = 0; /// No escapement. -const sal_Int16 API_ESCAPE_SUPERSCRIPT = 101; /// Superscript: raise characters automatically (magic value 101). -const sal_Int16 API_ESCAPE_SUBSCRIPT = -101; /// Subscript: lower characters automatically (magic value -101). +const sal_Int16 API_ESCAPE_NONE = 0; ///< No escapement. +const sal_Int16 API_ESCAPE_SUPERSCRIPT = 101; ///< Superscript: raise characters automatically (magic value 101). +const sal_Int16 API_ESCAPE_SUBSCRIPT = -101; ///< Subscript: lower characters automatically (magic value -101). -const sal_Int8 API_ESCAPEHEIGHT_NONE = 100; /// Relative character height if not escaped. -const sal_Int8 API_ESCAPEHEIGHT_DEFAULT = 58; /// Relative character height if escaped. +const sal_Int8 API_ESCAPEHEIGHT_NONE = 100; ///< Relative character height if not escaped. +const sal_Int8 API_ESCAPEHEIGHT_DEFAULT = 58; ///< Relative character height if escaped. // ============================================================================ diff --git a/oox/inc/oox/helper/modelobjecthelper.hxx b/oox/inc/oox/helper/modelobjecthelper.hxx index 2f657498a00e..aa6e980d27b1 100644 --- a/oox/inc/oox/helper/modelobjecthelper.hxx +++ b/oox/inc/oox/helper/modelobjecthelper.hxx @@ -58,11 +58,11 @@ private: private: mutable ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > - mxModelFactory; /// Factory to create the container. + mxModelFactory; ///< Factory to create the container. mutable ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameContainer > - mxContainer; /// Container for the objects. - ::rtl::OUString maServiceName; /// Service name to create the container. - sal_Int32 mnIndex; /// Index to create unique identifiers. + mxContainer; ///< Container for the objects. + ::rtl::OUString maServiceName; ///< Service name to create the container. + sal_Int32 mnIndex; ///< Index to create unique identifiers. }; // ============================================================================ @@ -104,15 +104,15 @@ public: ::rtl::OUString insertFillBitmapUrl( const ::rtl::OUString& rGraphicUrl ); private: - ObjectContainer maMarkerContainer; /// Contains all named line markers (line end polygons). - ObjectContainer maDashContainer; /// Contains all named line dsahes. - ObjectContainer maGradientContainer; /// Contains all named fill gradients. - ObjectContainer maTransGradContainer; /// Contains all named transparency Gradients. - ObjectContainer maBitmapUrlContainer; /// Contains all named fill bitmap URLs. - const ::rtl::OUString maDashNameBase; /// Base name for all named line dashes. - const ::rtl::OUString maGradientNameBase; /// Base name for all named fill gradients. - const ::rtl::OUString maTransGradNameBase; /// Base name for all named fill gradients. - const ::rtl::OUString maBitmapUrlNameBase; /// Base name for all named fill bitmap URLs. + ObjectContainer maMarkerContainer; ///< Contains all named line markers (line end polygons). + ObjectContainer maDashContainer; ///< Contains all named line dsahes. + ObjectContainer maGradientContainer; ///< Contains all named fill gradients. + ObjectContainer maTransGradContainer; ///< Contains all named transparency Gradients. + ObjectContainer maBitmapUrlContainer; ///< Contains all named fill bitmap URLs. + const ::rtl::OUString maDashNameBase; ///< Base name for all named line dashes. + const ::rtl::OUString maGradientNameBase; ///< Base name for all named fill gradients. + const ::rtl::OUString maTransGradNameBase; ///< Base name for all named fill gradients. + const ::rtl::OUString maBitmapUrlNameBase; ///< Base name for all named fill bitmap URLs. }; // ============================================================================ diff --git a/oox/inc/oox/helper/propertyset.hxx b/oox/inc/oox/helper/propertyset.hxx index ecf1807cdd43..75035e6fb744 100644 --- a/oox/inc/oox/helper/propertyset.hxx +++ b/oox/inc/oox/helper/propertyset.hxx @@ -130,11 +130,11 @@ private: private: ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > - mxPropSet; /// The mandatory property set interface. + mxPropSet; ///< The mandatory property set interface. ::com::sun::star::uno::Reference< ::com::sun::star::beans::XMultiPropertySet > - mxMultiPropSet; /// The optional multi property set interface. + mxMultiPropSet; ///< The optional multi property set interface. ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > - mxPropSetInfo; /// Property information. + mxPropSetInfo; ///< Property information. }; // ============================================================================ diff --git a/oox/inc/oox/helper/storagebase.hxx b/oox/inc/oox/helper/storagebase.hxx index 572185d47b85..f22e0acda7e7 100644 --- a/oox/inc/oox/helper/storagebase.hxx +++ b/oox/inc/oox/helper/storagebase.hxx @@ -171,15 +171,15 @@ private: private: typedef RefMap< ::rtl::OUString, StorageBase > SubStorageMap; - SubStorageMap maSubStorages; /// Map of direct sub storages. + SubStorageMap maSubStorages; ///< Map of direct sub storages. ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > - mxInStream; /// Cached base input stream (to keep it alive). + mxInStream; ///< Cached base input stream (to keep it alive). ::com::sun::star::uno::Reference< ::com::sun::star::io::XStream > - mxOutStream; /// Cached base output stream (to keep it alive). - ::rtl::OUString maParentPath; /// Full path of parent storage. - ::rtl::OUString maStorageName; /// Name of this storage, if it is a substorage. - bool mbBaseStreamAccess; /// True = access base streams with empty stream name. - bool mbReadOnly; /// True = storage opened read-only (based on input stream). + mxOutStream; ///< Cached base output stream (to keep it alive). + ::rtl::OUString maParentPath; ///< Full path of parent storage. + ::rtl::OUString maStorageName; ///< Name of this storage, if it is a substorage. + bool mbBaseStreamAccess; ///< True = access base streams with empty stream name. + bool mbReadOnly; ///< True = storage opened read-only (based on input stream). }; // ============================================================================ diff --git a/oox/inc/oox/helper/zipstorage.hxx b/oox/inc/oox/helper/zipstorage.hxx index ff6801936f38..94049eb144e5 100644 --- a/oox/inc/oox/helper/zipstorage.hxx +++ b/oox/inc/oox/helper/zipstorage.hxx @@ -76,7 +76,7 @@ private: private: ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage > - mxStorage; /// Storage based on input or output stream. + mxStorage; ///< Storage based on input or output stream. }; // ============================================================================ |