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 /registry | |
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 'registry')
-rw-r--r-- | registry/inc/registry/reader.h | 2 | ||||
-rw-r--r-- | registry/inc/registry/reader.hxx | 2 | ||||
-rw-r--r-- | registry/inc/registry/registry.hxx | 13 | ||||
-rw-r--r-- | registry/inc/registry/types.h | 4 | ||||
-rw-r--r-- | registry/inc/registry/version.h | 2 | ||||
-rw-r--r-- | registry/inc/registry/writer.h | 2 | ||||
-rw-r--r-- | registry/inc/registry/writer.hxx | 8 |
7 files changed, 11 insertions, 22 deletions
diff --git a/registry/inc/registry/reader.h b/registry/inc/registry/reader.h index 9244735c7aa7..e455d0a1bfcd 100644 --- a/registry/inc/registry/reader.h +++ b/registry/inc/registry/reader.h @@ -39,8 +39,6 @@ extern "C" { #endif -/// @HTML - /** Creates a type reader working on a binary blob that represents a UNOIDL type. diff --git a/registry/inc/registry/reader.hxx b/registry/inc/registry/reader.hxx index cbb0c68f8d30..b3f464c377d9 100644 --- a/registry/inc/registry/reader.hxx +++ b/registry/inc/registry/reader.hxx @@ -42,8 +42,6 @@ namespace typereg { -/// @HTML - /** A type reader working on a binary blob that represents a UNOIDL type. diff --git a/registry/inc/registry/registry.hxx b/registry/inc/registry/registry.hxx index 37f8aa401a7d..8845fbdc077b 100644 --- a/registry/inc/registry/registry.hxx +++ b/registry/inc/registry/registry.hxx @@ -652,27 +652,26 @@ public: friend class Registry; public: + /// @cond INTERNAL + /** Constructor, which initialize a RegistryKey with registry and an valid key handle. This constructor is internal only. - @internal */ inline RegistryKey(Registry& registry, RegKeyHandle hKey); /** returns the internal key handle. - - @internal */ RegKeyHandle getKeyHandle() const { return m_hImpl; } protected: /** sets the internal registry on which this key should work. - - @internal */ inline void setRegistry(Registry& registry); + /// @endcond + /// stores the registry on which this key works Registry m_registry; /// stores the current key handle of this key @@ -787,6 +786,7 @@ inline RegistryKey::RegistryKey() : m_hImpl(NULL) { } +/// @cond INTERNAL inline RegistryKey::RegistryKey(Registry& registry, RegKeyHandle hKey) : m_registry(registry) , m_hImpl(hKey) @@ -794,6 +794,7 @@ inline RegistryKey::RegistryKey(Registry& registry, RegKeyHandle hKey) if (m_hImpl) m_registry.m_pApi->acquireKey(m_hImpl); } +/// @endcond inline RegistryKey::RegistryKey(const RegistryKey& toCopy) : m_registry(toCopy.m_registry) @@ -803,10 +804,12 @@ inline RegistryKey::RegistryKey(const RegistryKey& toCopy) m_registry.m_pApi->acquireKey(m_hImpl); } +/// @cond INTERNAL inline void RegistryKey::setRegistry(Registry& registry) { m_registry = registry; } +/// @endcond inline RegistryKey::~RegistryKey() { diff --git a/registry/inc/registry/types.h b/registry/inc/registry/types.h index 44ccda8abad6..cee37bb24001 100644 --- a/registry/inc/registry/types.h +++ b/registry/inc/registry/types.h @@ -100,6 +100,7 @@ enum RTTypeClass { */ RT_TYPE_UNION, + /// @cond INTERNAL /** Flag for published entities. @@ -111,11 +112,10 @@ enum RTTypeClass { addition changes the underlying type of this enumeration for any C/C++ compiler.) - @internal - @since UDK 3.2.0 */ RT_TYPE_PUBLISHED = 0x4000 + /// @endcond }; /** specifies the type for the field access. diff --git a/registry/inc/registry/version.h b/registry/inc/registry/version.h index bf4664287d0f..9f06d3778bed 100644 --- a/registry/inc/registry/version.h +++ b/registry/inc/registry/version.h @@ -35,8 +35,6 @@ extern "C" { #endif -/// @HTML - /** The version of a binary blob that represents a UNOIDL type. diff --git a/registry/inc/registry/writer.h b/registry/inc/registry/writer.h index 57a9f81c9684..0adaa1aa918b 100644 --- a/registry/inc/registry/writer.h +++ b/registry/inc/registry/writer.h @@ -39,8 +39,6 @@ extern "C" { #endif -/// @HTML - /** Creates a type writer working on a binary blob that represents a UNOIDL type. diff --git a/registry/inc/registry/writer.hxx b/registry/inc/registry/writer.hxx index ce7433c31129..248efef79cc5 100644 --- a/registry/inc/registry/writer.hxx +++ b/registry/inc/registry/writer.hxx @@ -41,8 +41,6 @@ namespace typereg { -/// @HTML - /** A type writer working on a binary blob that represents a UNOIDL type. @@ -135,9 +133,7 @@ public: @param typeName the type name of the field - @param valueType the type of the value of the field - - @param valueValue the value of the value of the field + @param value the value of the field @exception std::bad_alloc is raised if an out-of-memory condition occurs */ @@ -244,8 +240,6 @@ public: /** Sets the data of a reference of this type writer. - @param handle a handle on a type writer - @param index a valid index into the range of references of this type writer |