Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib/lang

Timestamp:

Jul 12, 2005, 12:33:16 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit

Location:

orxonox/trunk/src/lib/lang

Files:

• base_object.cc (modified) (6 diffs)
• base_object.h (modified) (3 diffs)
• class_list.cc (modified) (2 diffs)
• class_list.h (modified) (1 diff)

orxonox/trunk/src/lib/lang/base_object.cc

@@ -27 +27 @@
 
 /**
-   \brief sets the name from a LoadXML-Element
-   \param root the element to load from
+ *  sets the name from a LoadXML-Element
+ * @param root the element to load from
 */
 BaseObject::BaseObject(const TiXmlElement* root)
@@ -45 +45 @@
 
 /**
-   \brief standard deconstructor
+ *  standard deconstructor
 */
 BaseObject::~BaseObject ()
@@ -56 +56 @@
 
 /**
-   \brief loads parameters
-   \param root the element to load from
+ *  loads parameters
+ * @param root the element to load from
 */
 void BaseObject::loadParams(const TiXmlElement* root)
@@ -67 +67 @@
 
 /**
-   \brief sets the class identifiers
-   \param id a number for the class from class_id.h enumeration
-   \param className the class name
+ *  sets the class identifiers
+ * @param id a number for the class from class_id.h enumeration
+ * @param className the class name
 */
 void BaseObject::setClassID(long classID, const char* className)
@@ -97 +97 @@
 
 /**
-   \brief checks if the class is a classID
-   \param classID the Identifier to check for
-   \returns true if it is, false otherwise
+ *  checks if the class is a classID
+ * @param classID the Identifier to check for
+ * @returns true if it is, false otherwise
 */
 bool BaseObject::isA (long classID) const
@@ -118 +118 @@
 
 /**
- * @brief displays everything this class is
+ *  displays everything this class is
  */
 void BaseObject::whatIs() const

orxonox/trunk/src/lib/lang/base_object.h

@@ -1 +1 @@
 /*!
     \file base_object.h
-    \brief Definition of the base object class.
+  *  Definition of the base object class.
 
     This is a global handler for all classes.
@@ -30 +30 @@
   inline const char* getName ()const { return this->objectName; };
 
-  /** \returns the className of the corresponding Object */
+  /** @returns the className of the corresponding Object */
   inline const char* getClassName() const { return this->className; };
-  /** \returns the classID of the corresponding Object */
+  /** @returns the classID of the corresponding Object */
   inline int getClassID() const { return this->classID; }
 
@@ -38 +38 @@
   void whatIs() const;
 
-  /** \returns if the object is finalized */
+  /** @returns if the object is finalized */
   inline bool isFinalized() { return this->finalized; }
 

orxonox/trunk/src/lib/lang/class_list.cc

@@ -29 +29 @@
 
 /**
-   \brief Creates a new ClassList
+ *  Creates a new ClassList
 */
 ClassList::ClassList(const long& classID, const char* className)
@@ -43 +43 @@
 
 /**
-   \brief standard deconstructor
+ *  standard deconstructor
 */
 ClassList::~ClassList ()

orxonox/trunk/src/lib/lang/class_list.h

@@ -1 +1 @@
 /*!
     \file class_list.h
-    \brief Definition of the Class List, that handles a Class-Specific-Control structure
+  *  Definition of the Class List, that handles a Class-Specific-Control structure
 
  */