diff options
author | Stephan Bergmann <sbergman@redhat.com> | 2012-01-05 19:40:38 +0100 |
---|---|---|
committer | Stephan Bergmann <sbergman@redhat.com> | 2012-01-05 19:43:14 +0100 |
commit | 58ab12acf576a765ec47cc2753ba57643e51d653 (patch) | |
tree | 79c07bddbdf3e8e6db677eb0b94e8a2880d308c1 /salhelper | |
parent | 7482e974117df2bdc737785efdf9eb410787c7b4 (diff) |
Switch from autodoc to doxygen for SDK C++ documentation.
* New build prerequisite doxygen (controllable via --with-doxygen).
* Adapted various headers to slightly different doxygen documentation
syntax, but much clean up still remains to be done (i.e., warnings
emitted by doxygen fixed).
Diffstat (limited to 'salhelper')
-rw-r--r-- | salhelper/inc/salhelper/simplereferenceobject.hxx | 10 | ||||
-rw-r--r-- | salhelper/inc/salhelper/singletonref.hxx | 8 |
2 files changed, 9 insertions, 9 deletions
diff --git a/salhelper/inc/salhelper/simplereferenceobject.hxx b/salhelper/inc/salhelper/simplereferenceobject.hxx index 13c8d658400d..6fea2377e8cb 100644 --- a/salhelper/inc/salhelper/simplereferenceobject.hxx +++ b/salhelper/inc/salhelper/simplereferenceobject.hxx @@ -75,7 +75,7 @@ class SALHELPER_DLLPUBLIC SimpleReferenceObject public: inline SimpleReferenceObject() SAL_THROW(()): m_nCount(0) {} - /** @ATTENTION + /** @attention The results are undefined if, for any individual instance of SimpleReferenceObject, the total number of calls to acquire() exceeds the total number of calls to release() by a platform dependent amount @@ -113,15 +113,15 @@ private: oslInterlockedCount m_nCount; /** not implemented - @internal */ SALHELPER_DLLPRIVATE SimpleReferenceObject(SimpleReferenceObject &); /** not implemented - @internal */ SALHELPER_DLLPRIVATE void operator =(SimpleReferenceObject); + /// @cond INTERNAL + #ifdef _MSC_VER /* We can't now have these private with MSVC2008 at least, it leads to compilation errors in xmloff and other places. @@ -129,14 +129,14 @@ private: protected: #endif /** not implemented (see general class documentation) - @internal */ static void * operator new[](std::size_t); /** not implemented (see general class documentation) - @internal */ static void operator delete[](void * pPtr); + + /// @endcond }; } diff --git a/salhelper/inc/salhelper/singletonref.hxx b/salhelper/inc/salhelper/singletonref.hxx index bf9dc69f7f87..2c86b12f1139 100644 --- a/salhelper/inc/salhelper/singletonref.hxx +++ b/salhelper/inc/salhelper/singletonref.hxx @@ -47,7 +47,7 @@ namespace salhelper{ /** @short template for implementing singleton classes. - @descr Such classes can be instanciated everytimes they + Such classes can be instanciated everytimes they are needed. But the internal wrapped object will be created one times only. Of course its used resources are referenced one times only too. @@ -100,7 +100,7 @@ class SingletonRef /** @short standard ctor. - @descr The internal wrapped object is created only, + The internal wrapped object is created only, if its ref count was 0. Otherwhise this method does nothing ... except increasing of the internal ref count! @@ -124,7 +124,7 @@ class SingletonRef /** @short standard dtor. - @descr The internal wrapped object is removed only, + The internal wrapped object is removed only, if its ref count wil be 0. Otherwhise this method does nothing ... except decreasing of the internal ref count! @@ -178,7 +178,7 @@ class SingletonRef /** @short creates an own mutex for guarding static contents. - @descr The global mutex the osl library is used one times + The global mutex the osl library is used one times only to create an own static mutex, which can be used next time to guard own static member operations. */ |