Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib/sound/sound_engine.h

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

File:

• orxonox/trunk/src/lib/sound/sound_engine.h (modified) (4 diffs)

orxonox/trunk/src/lib/sound/sound_engine.h

@@ -1 +1 @@
 /*!
     \file sound_engine.h
-    \brief Definition of the SoundEngine singleton Class
+  *  Definition of the SoundEngine singleton Class
 */
 
@@ -26 +26 @@
   ~SoundBuffer();
 
-  /** \returns the ID of the buffer used in this SoundBuffer */
+  /** @returns the ID of the buffer used in this SoundBuffer */
   inline ALuint getID() { return this->bufferID; }
 
@@ -50 +50 @@
 
   // development functions
-  /** \returns The ID of this Source */
+  /** @returns The ID of this Source */
   inline ALuint getID() const { return this->sourceID; }
-  /** \returns the SoundBuffer of this Source */
+  /** @returns the SoundBuffer of this Source */
   inline SoundBuffer* getBuffer() const { return this->buffer; }
-  /** \returns the SourceNode of this Source */
+  /** @returns the SourceNode of this Source */
   inline PNode* getNode() const { return this->sourceNode;}
 
@@ -72 +72 @@
  public:
   virtual ~SoundEngine();
-  /** \returns a Pointer to the only object of this Class */
+  /** @returns a Pointer to the only object of this Class */
   inline static SoundEngine* getInstance() { if (!singletonRef) singletonRef = new SoundEngine();  return singletonRef; };