From f2fa2bf4c195d0b4b3c54a9a15bad866bafdd3e3 Mon Sep 17 00:00:00 2001 From: Jean-Paul Chaput Date: Fri, 3 Apr 2009 14:21:04 +0000 Subject: [PATCH] * ./hurricane/doc/hurricane : - Bug: In the various Property sub-types dox file the Hurricane namespace wasn't closed, resulting in the deseapearance of thoses classes in the documentation (painful to diagnose). Still, the doc for the derived Property mostly remains to be written. - Bug: clearing some remnants of a merge conflict in DataBase.dox. --- hurricane/doc/hurricane/DataBase.dox | 15 --------------- hurricane/doc/hurricane/PrivateProperty.dox | 8 ++------ hurricane/doc/hurricane/Property.dox | 12 ++++++------ hurricane/doc/hurricane/SharedProperty.dox | 5 +---- .../doc/hurricane/StandardPrivateProperty.dox | 6 +----- .../doc/hurricane/StandardSharedProperty.dox | 6 ++---- hurricane/doc/hurricane/doxyfile | 7 ++++++- 7 files changed, 18 insertions(+), 41 deletions(-) diff --git a/hurricane/doc/hurricane/DataBase.dox b/hurricane/doc/hurricane/DataBase.dox index bf368cb1..3416c7f5 100644 --- a/hurricane/doc/hurricane/DataBase.dox +++ b/hurricane/doc/hurricane/DataBase.dox @@ -57,21 +57,6 @@ * \return the root Library if it exists, else \NULL. */ - -<<<<<<< .mine - - /*! \addtogroup Generalities - * \{ - */ - - /*! \function DataBase* DataBase::getDB (); - * This global generic function returns the current - * DataBase, if it has been created and not destroyed, - * else \NULL. - */ - -======= ->>>>>>> .r207 // \} } diff --git a/hurricane/doc/hurricane/PrivateProperty.dox b/hurricane/doc/hurricane/PrivateProperty.dox index 42c272b1..38b884a3 100644 --- a/hurricane/doc/hurricane/PrivateProperty.dox +++ b/hurricane/doc/hurricane/PrivateProperty.dox @@ -71,15 +71,11 @@ */ // \{ - /*! \function DBo* PrivateProperty::GetOwner() const; + /*! \function DBo* PrivateProperty::getOwner() const; * \Return the current owner of the property (or NULL if at not been * assigned yet). */ // \} - - /*! \name Messages - */ - // \{ - + } // End of Hurricane namespace. diff --git a/hurricane/doc/hurricane/Property.dox b/hurricane/doc/hurricane/Property.dox index a209a574..7a09a314 100644 --- a/hurricane/doc/hurricane/Property.dox +++ b/hurricane/doc/hurricane/Property.dox @@ -108,11 +108,11 @@ Properties Occurrence::getProperties() const; * * Does the object have properties ? \code -bool DBo::HasProperty() const; +bool DBo::hasProperty() const; \endcode * Return \true if the object owns at least a property, else \false. \code -bool Occurrence::HasProperty() const; +bool Occurrence::hasProperty() const; \endcode * This function searches the quark representing the occurence. * @@ -123,12 +123,12 @@ bool Occurrence::HasProperty() const; * * Adding a property : things becomes a little harder \code -void DBo::Put(Property* property); +void DBo::put(Property* property); \endcode * Adds the property \c \ to the set of properties of * the object. \code -void Occurence::Put(Property* property); +void Occurence::put(Property* property); \endcode * This function searches the quark representing the occurence. * @@ -188,11 +188,11 @@ void Occurence::Remove(Property* property); * * Clearing all properties \code -void DBo::ClearProperties(); +void DBo::clearProperties(); \endcode * Removes all properties attached to the object. \code -void Occurence::ClearProperties(); +void Occurence::clearProperties(); \endcode * First searches for the quark associated to the occurence. * diff --git a/hurricane/doc/hurricane/SharedProperty.dox b/hurricane/doc/hurricane/SharedProperty.dox index bc4a38d0..538de56d 100644 --- a/hurricane/doc/hurricane/SharedProperty.dox +++ b/hurricane/doc/hurricane/SharedProperty.dox @@ -81,7 +81,4 @@ // \} - /*! \name Messages - */ - // \{ - + } // End of Hurricane namespace. diff --git a/hurricane/doc/hurricane/StandardPrivateProperty.dox b/hurricane/doc/hurricane/StandardPrivateProperty.dox index b10587d9..bdef05c8 100644 --- a/hurricane/doc/hurricane/StandardPrivateProperty.dox +++ b/hurricane/doc/hurricane/StandardPrivateProperty.dox @@ -14,8 +14,4 @@ */ - - /*! \name Constructors - */ - // \{ - + } // End of Hurricane namespace. diff --git a/hurricane/doc/hurricane/StandardSharedProperty.dox b/hurricane/doc/hurricane/StandardSharedProperty.dox index d6d31f82..69d27df7 100644 --- a/hurricane/doc/hurricane/StandardSharedProperty.dox +++ b/hurricane/doc/hurricane/StandardSharedProperty.dox @@ -13,9 +13,7 @@ * relation between a name and a value. */ + // \} - /*! \name Constructors - */ - // \{ - + } // End of Hurricane namespace. diff --git a/hurricane/doc/hurricane/doxyfile b/hurricane/doc/hurricane/doxyfile index d4331684..c8af3fb9 100644 --- a/hurricane/doc/hurricane/doxyfile +++ b/hurricane/doc/hurricane/doxyfile @@ -572,7 +572,7 @@ WARN_FORMAT = "$file:$line: $text" # and error messages should be written. If left blank the output is written # to stderr. -WARN_LOGFILE = +WARN_LOGFILE = doxygen.warn.log #--------------------------------------------------------------------------- # configuration options related to the input files @@ -603,6 +603,7 @@ INPUT = ../../src/hurricane/hurricane/Commons.h \ Filter.dox \ ../../src/hurricane/hurricane/Relation.h \ Relation.dox \ + StandardRelation.dox \ ../../src/hurricane/hurricane/Tabulation.h \ Tabulation.dox \ ../../src/hurricane/hurricane/DbU.h \ @@ -685,6 +686,10 @@ INPUT = ../../src/hurricane/hurricane/Commons.h \ ../../src/hurricane/hurricane/Properties.h \ ../../src/hurricane/hurricane/Property.h \ Property.dox \ + PrivateProperty.dox \ + SharedProperty.dox \ + StandardSharedProperty.dox \ + StandardPrivateProperty.dox \ ../../src/hurricane/hurricane/Hooks.h \ ../../src/hurricane/hurricane/Hook.h \ Hook.dox \