Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib/sound
- Timestamp:
- Jul 12, 2005, 12:33:16 AM (19 years ago)
-
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/sound
- Files:
-
- 3 edited
-
ogg_player.h (modified) (1 diff)
-
sound_engine.cc (modified) (23 diffs)
-
sound_engine.h (modified) (4 diffs)
Legend:
- Unmodified
- Added
- Removed
-
orxonox/trunk/src/lib/sound/ogg_player.h
r4750 r4836 1 1 /*! 2 2 * @file ogg_player.h 3 * @briefOgg-Player definition3 * Ogg-Player definition 4 4 */ 5 5 -
orxonox/trunk/src/lib/sound/sound_engine.cc
r4830 r4836 35 35 ////////////////// 36 36 /** 37 \briefCreates a Soundbuffer out of an inputfile38 \param fileName The name of the File37 * Creates a Soundbuffer out of an inputfile 38 * @param fileName The name of the File 39 39 */ 40 40 SoundBuffer::SoundBuffer(const char* fileName) … … 89 89 ////////////////// 90 90 /** 91 \briefcreates a SoundSource at position sourceNode with the SoundBuffer buffer91 * creates a SoundSource at position sourceNode with the SoundBuffer buffer 92 92 */ 93 93 SoundSource::SoundSource(SoundBuffer* buffer, PNode* sourceNode) … … 113 113 114 114 /** 115 \briefdeletes a SoundSource115 * deletes a SoundSource 116 116 */ 117 117 SoundSource::~SoundSource() … … 123 123 124 124 /** 125 \briefPlays back a SoundSource125 * Plays back a SoundSource 126 126 */ 127 127 void SoundSource::play() … … 131 131 132 132 /** 133 \briefStops playback of a SoundSource133 * Stops playback of a SoundSource 134 134 */ 135 135 void SoundSource::stop() … … 139 139 140 140 /** 141 \briefPauses Playback of a SoundSource141 * Pauses Playback of a SoundSource 142 142 */ 143 143 void SoundSource::pause() … … 147 147 148 148 /** 149 \briefRewinds Playback of a SoundSource149 * Rewinds Playback of a SoundSource 150 150 */ 151 151 void SoundSource::rewind() … … 155 155 156 156 /** 157 \briefsets the RolloffFactor of the Sound emitted from the SoundSource158 \param rolloffFactor The Factor described157 * sets the RolloffFactor of the Sound emitted from the SoundSource 158 * @param rolloffFactor The Factor described 159 159 160 160 this tells openAL how fast the Sounds decay outward from the Source … … 171 171 ////////////////// 172 172 /** 173 \briefstandard constructor173 * standard constructor 174 174 */ 175 175 SoundEngine::SoundEngine () … … 184 184 185 185 /** 186 \briefthe singleton reference to this class186 * the singleton reference to this class 187 187 */ 188 188 SoundEngine* SoundEngine::singletonRef = NULL; 189 189 190 190 /** 191 \briefstandard deconstructor191 * standard deconstructor 192 192 193 193 */ … … 221 221 222 222 /** 223 \briefcreates a new SoundSource.224 \param fileName The Name to load the SoundBuffer from225 \param sourceNode The sourceNode to bind this SoundSource to.226 \returns The newly created SoundSource223 * creates a new SoundSource. 224 * @param fileName The Name to load the SoundBuffer from 225 * @param sourceNode The sourceNode to bind this SoundSource to. 226 * @returns The newly created SoundSource 227 227 228 228 acctualy this is nothing more than a wrapper around the ResourceManager. … … 235 235 236 236 /** 237 \briefsets The listener (normaly the Camera)237 * sets The listener (normaly the Camera) 238 238 */ 239 239 void SoundEngine::setListener(PNode* listener) … … 243 243 244 244 /** 245 \briefSets the doppler values of openAL246 \param dopplerFactor the extent of the doppler-effect247 \param dopplerVelocity the Speed the sound travels245 * Sets the doppler values of openAL 246 * @param dopplerFactor the extent of the doppler-effect 247 * @param dopplerVelocity the Speed the sound travels 248 248 */ 249 249 void SoundEngine::setDopplerValues(ALfloat dopplerFactor, ALfloat dopplerVelocity) … … 255 255 256 256 /** 257 \briefadds a SoundBuffer to the bufferList of the SoundEngine258 \param buffer The buffer to add to the bufferList257 * adds a SoundBuffer to the bufferList of the SoundEngine 258 * @param buffer The buffer to add to the bufferList 259 259 */ 260 260 void SoundEngine::addBuffer(SoundBuffer* buffer) … … 264 264 265 265 /** 266 \briefremoves a SoundBuffer from the bufferList of the SoundEngine267 \param buffer The buffer to delete from the SoundEngine266 * removes a SoundBuffer from the bufferList of the SoundEngine 267 * @param buffer The buffer to delete from the SoundEngine 268 268 */ 269 269 void SoundEngine::removeBuffer(SoundBuffer* buffer) … … 285 285 286 286 /** 287 \briefadds a SoundSource to the sourceList of the SoundEngine288 \param source The source to add to the sourceList287 * adds a SoundSource to the sourceList of the SoundEngine 288 * @param source The source to add to the sourceList 289 289 */ 290 290 void SoundEngine::addSource(SoundSource* source) … … 294 294 295 295 /** 296 \briefremoves a SoundSource from the sourceList of the SoundEngine297 \param source The source to delete from the SoundEngine296 * removes a SoundSource from the sourceList of the SoundEngine 297 * @param source The source to delete from the SoundEngine 298 298 */ 299 299 void SoundEngine::removeSource(SoundSource* source) … … 304 304 305 305 /** 306 \briefupdates all The positions, Directions and Velocities of all Sounds306 * updates all The positions, Directions and Velocities of all Sounds 307 307 */ 308 308 void SoundEngine::update() … … 349 349 350 350 /** 351 \briefRemoves all the Buffers that are not anymore needed by any Sources351 * Removes all the Buffers that are not anymore needed by any Sources 352 352 */ 353 353 void SoundEngine::flushUnusedBuffers() … … 374 374 375 375 /** 376 \briefSourceEngine::flushAllBuffers376 * SourceEngine::flushAllBuffers 377 377 */ 378 378 void SoundEngine::flushAllBuffers() … … 389 389 390 390 /** 391 * @briefSourceEngine::flushAllBuffers391 * SourceEngine::flushAllBuffers 392 392 */ 393 393 void SoundEngine::flushAllSources() … … 405 405 406 406 /** 407 \briefinitializes Audio in general407 * initializes Audio in general 408 408 */ 409 409 bool SoundEngine::initAudio() … … 421 421 422 422 /** 423 \briefTransforms AL-errors into something readable424 \param err The error found423 * Transforms AL-errors into something readable 424 * @param err The error found 425 425 */ 426 426 void SoundEngine::PrintALErrorString(ALenum err) -
orxonox/trunk/src/lib/sound/sound_engine.h
r4830 r4836 1 1 /*! 2 2 \file sound_engine.h 3 \briefDefinition of the SoundEngine singleton Class3 * Definition of the SoundEngine singleton Class 4 4 */ 5 5 … … 26 26 ~SoundBuffer(); 27 27 28 /** \returns the ID of the buffer used in this SoundBuffer */28 /** @returns the ID of the buffer used in this SoundBuffer */ 29 29 inline ALuint getID() { return this->bufferID; } 30 30 … … 50 50 51 51 // development functions 52 /** \returns The ID of this Source */52 /** @returns The ID of this Source */ 53 53 inline ALuint getID() const { return this->sourceID; } 54 /** \returns the SoundBuffer of this Source */54 /** @returns the SoundBuffer of this Source */ 55 55 inline SoundBuffer* getBuffer() const { return this->buffer; } 56 /** \returns the SourceNode of this Source */56 /** @returns the SourceNode of this Source */ 57 57 inline PNode* getNode() const { return this->sourceNode;} 58 58 … … 72 72 public: 73 73 virtual ~SoundEngine(); 74 /** \returns a Pointer to the only object of this Class */74 /** @returns a Pointer to the only object of this Class */ 75 75 inline static SoundEngine* getInstance() { if (!singletonRef) singletonRef = new SoundEngine(); return singletonRef; }; 76 76
Note: See TracChangeset
for help on using the changeset viewer.
