Kaydet (Commit) f5102178 authored tarafından Miklos Vajna's avatar Miklos Vajna

oox: fix doxygen comments in helper

Change-Id: I1e9b2075cbbb7a2ad7de64dd449cb42bf95ecc20
üst eb020150
...@@ -312,10 +312,10 @@ public: ...@@ -312,10 +312,10 @@ public:
inline BinaryXInputStream& operator>>( Type& ornValue ) { readValue( ornValue ); return *this; } inline BinaryXInputStream& operator>>( Type& ornValue ) { readValue( ornValue ); return *this; }
private: 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 > ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >
mxInStrm; /// Reference to the input stream. mxInStrm; ///< Reference to the input stream.
bool mbAutoClose; /// True = automatically close stream on destruction. bool mbAutoClose; ///< True = automatically close stream on destruction.
}; };
// ============================================================================ // ============================================================================
......
...@@ -143,10 +143,10 @@ public: ...@@ -143,10 +143,10 @@ public:
getXOutputStream() const { return mxOutStrm; } getXOutputStream() const { return mxOutStrm; }
private: 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 > ::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream >
mxOutStrm; /// Reference to the output stream. mxOutStrm; ///< Reference to the output stream.
bool mbAutoClose; /// True = automatically close stream on destruction. bool mbAutoClose; ///< True = automatically close stream on destruction.
}; };
// ============================================================================ // ============================================================================
......
...@@ -115,10 +115,10 @@ private: ...@@ -115,10 +115,10 @@ private:
BinaryStreamBase& operator=( const BinaryStreamBase& ); BinaryStreamBase& operator=( const BinaryStreamBase& );
protected: protected:
bool mbEof; /// End of stream flag. bool mbEof; ///< End of stream flag.
private: private:
const bool mbSeekable; /// True = implementation supports seeking. const bool mbSeekable; ///< True = implementation supports seeking.
}; };
// ============================================================================ // ============================================================================
...@@ -146,7 +146,7 @@ protected: ...@@ -146,7 +146,7 @@ protected:
private: private:
::com::sun::star::uno::Reference< ::com::sun::star::io::XSeekable > ::com::sun::star::uno::Reference< ::com::sun::star::io::XSeekable >
mxSeekable; /// Stream seeking interface. mxSeekable; ///< Stream seeking interface.
}; };
// ============================================================================ // ============================================================================
...@@ -174,8 +174,8 @@ protected: ...@@ -174,8 +174,8 @@ protected:
explicit SequenceSeekableStream( const StreamDataSequence& rData ); explicit SequenceSeekableStream( const StreamDataSequence& rData );
protected: protected:
const StreamDataSequence* mpData; /// Wrapped data sequence. const StreamDataSequence* mpData; ///< Wrapped data sequence.
sal_Int32 mnPos; /// Current position in the sequence. sal_Int32 mnPos; ///< Current position in the sequence.
}; };
// ============================================================================ // ============================================================================
......
...@@ -149,14 +149,14 @@ private: ...@@ -149,14 +149,14 @@ private:
::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > mxContext; ::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::graphic::XGraphicProvider > mxGraphicProvider;
::com::sun::star::uno::Reference< ::com::sun::star::awt::XUnitConversion > mxUnitConversion; ::com::sun::star::uno::Reference< ::com::sun::star::awt::XUnitConversion > mxUnitConversion;
::com::sun::star::awt::DeviceInfo maDeviceInfo; /// Current output device info. ::com::sun::star::awt::DeviceInfo maDeviceInfo; ///< Current output device info.
SystemPalette maSystemPalette; /// Maps system colors (XML tokens) to RGB color values. SystemPalette maSystemPalette; ///< Maps system colors (XML tokens) to RGB color values.
StorageRef mxStorage; /// Storage containing embedded graphics. StorageRef mxStorage; ///< Storage containing embedded graphics.
mutable GraphicObjectDeque maGraphicObjects; /// Caches all created graphic objects to keep them alive. mutable GraphicObjectDeque maGraphicObjects; ///< Caches all created graphic objects to keep them alive.
mutable EmbeddedGraphicMap maEmbeddedGraphics; /// Maps all embedded graphics by their storage path. mutable EmbeddedGraphicMap maEmbeddedGraphics; ///< Maps all embedded graphics by their storage path.
const ::rtl::OUString maGraphicObjScheme; /// The URL scheme name for graphic objects. 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 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. double mfPixelPerHmmY; ///< Number of screen pixels per 1/100 mm in Y direction.
}; };
// ============================================================================ // ============================================================================
......
...@@ -85,9 +85,9 @@ const sal_uInt8 WINDOWS_CHARSET_OEM = 255; ...@@ -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_TRANSPARENT = -1; ///< Transparent color for API calls.
const sal_Int32 API_RGB_BLACK = 0x000000; /// Black 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_WHITE = 0xFFFFFF; ///< White color for API calls.
const sal_Int16 API_LINE_SOLID = 0; const sal_Int16 API_LINE_SOLID = 0;
const sal_Int16 API_LINE_DOTTED = 1; const sal_Int16 API_LINE_DOTTED = 1;
...@@ -99,12 +99,12 @@ const sal_Int16 API_LINE_THIN = 35; ...@@ -99,12 +99,12 @@ const sal_Int16 API_LINE_THIN = 35;
const sal_Int16 API_LINE_MEDIUM = 88; const sal_Int16 API_LINE_MEDIUM = 88;
const sal_Int16 API_LINE_THICK = 141; const sal_Int16 API_LINE_THICK = 141;
const sal_Int16 API_ESCAPE_NONE = 0; /// No escapement. 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_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_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_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_DEFAULT = 58; ///< Relative character height if escaped.
// ============================================================================ // ============================================================================
......
...@@ -58,11 +58,11 @@ private: ...@@ -58,11 +58,11 @@ private:
private: private:
mutable ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > 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 > mutable ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameContainer >
mxContainer; /// Container for the objects. mxContainer; ///< Container for the objects.
::rtl::OUString maServiceName; /// Service name to create the container. ::rtl::OUString maServiceName; ///< Service name to create the container.
sal_Int32 mnIndex; /// Index to create unique identifiers. sal_Int32 mnIndex; ///< Index to create unique identifiers.
}; };
// ============================================================================ // ============================================================================
...@@ -104,15 +104,15 @@ public: ...@@ -104,15 +104,15 @@ public:
::rtl::OUString insertFillBitmapUrl( const ::rtl::OUString& rGraphicUrl ); ::rtl::OUString insertFillBitmapUrl( const ::rtl::OUString& rGraphicUrl );
private: private:
ObjectContainer maMarkerContainer; /// Contains all named line markers (line end polygons). ObjectContainer maMarkerContainer; ///< Contains all named line markers (line end polygons).
ObjectContainer maDashContainer; /// Contains all named line dsahes. ObjectContainer maDashContainer; ///< Contains all named line dsahes.
ObjectContainer maGradientContainer; /// Contains all named fill gradients. ObjectContainer maGradientContainer; ///< Contains all named fill gradients.
ObjectContainer maTransGradContainer; /// Contains all named transparency Gradients. ObjectContainer maTransGradContainer; ///< Contains all named transparency Gradients.
ObjectContainer maBitmapUrlContainer; /// Contains all named fill bitmap URLs. ObjectContainer maBitmapUrlContainer; ///< Contains all named fill bitmap URLs.
const ::rtl::OUString maDashNameBase; /// Base name for all named line dashes. 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 maGradientNameBase; ///< Base name for all named fill gradients.
const ::rtl::OUString maTransGradNameBase; /// 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. const ::rtl::OUString maBitmapUrlNameBase; ///< Base name for all named fill bitmap URLs.
}; };
// ============================================================================ // ============================================================================
......
...@@ -130,11 +130,11 @@ private: ...@@ -130,11 +130,11 @@ private:
private: private:
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > ::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 > ::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 > ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo >
mxPropSetInfo; /// Property information. mxPropSetInfo; ///< Property information.
}; };
// ============================================================================ // ============================================================================
......
...@@ -171,15 +171,15 @@ private: ...@@ -171,15 +171,15 @@ private:
private: private:
typedef RefMap< ::rtl::OUString, StorageBase > SubStorageMap; 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 > ::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 > ::com::sun::star::uno::Reference< ::com::sun::star::io::XStream >
mxOutStream; /// Cached base output stream (to keep it alive). mxOutStream; ///< Cached base output stream (to keep it alive).
::rtl::OUString maParentPath; /// Full path of parent storage. ::rtl::OUString maParentPath; ///< Full path of parent storage.
::rtl::OUString maStorageName; /// Name of this storage, if it is a substorage. ::rtl::OUString maStorageName; ///< Name of this storage, if it is a substorage.
bool mbBaseStreamAccess; /// True = access base streams with empty stream name. bool mbBaseStreamAccess; ///< True = access base streams with empty stream name.
bool mbReadOnly; /// True = storage opened read-only (based on input stream). bool mbReadOnly; ///< True = storage opened read-only (based on input stream).
}; };
// ============================================================================ // ============================================================================
......
...@@ -76,7 +76,7 @@ private: ...@@ -76,7 +76,7 @@ private:
private: private:
::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage > ::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.
}; };
// ============================================================================ // ============================================================================
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment