Skip to content

Commit

Permalink
📚 Doxygen: added module Audio
Browse files Browse the repository at this point in the history
  • Loading branch information
ohlidalp authored and Petr Ohlídal committed Apr 9, 2022
1 parent b1a9e16 commit 87024e1
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 0 deletions.
5 changes: 5 additions & 0 deletions source/main/audio/MumbleIntegration.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@

namespace RoR {

/// @addtogroup Audio
/// @{

class MumbleIntegration : public ZeroedMemoryAllocator
{
public:
Expand Down Expand Up @@ -80,6 +83,8 @@ class MumbleIntegration : public ZeroedMemoryAllocator
LinkedMem* lm;
};

/// @}

} // namespace RoR

#endif //USE_MUMBLE
5 changes: 5 additions & 0 deletions source/main/audio/Sound.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@

namespace RoR {

/// @addtogroup Audio
/// @{

class Sound : public ZeroedMemoryAllocator
{
friend class SoundManager;
Expand Down Expand Up @@ -84,6 +87,8 @@ class Sound : public ZeroedMemoryAllocator
int source_index;
};

/// @}

} // namespace RoR

#endif // USE_OPENAL
5 changes: 5 additions & 0 deletions source/main/audio/SoundManager.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@

namespace RoR {

/// @addtogroup Audio
/// @{

class SoundManager : public ZeroedMemoryAllocator
{
friend class Sound;
Expand Down Expand Up @@ -94,6 +97,8 @@ class SoundManager : public ZeroedMemoryAllocator
ALCcontext* sound_context;
};

/// @}

} // namespace RoR

#endif // USE_OPENAL
5 changes: 5 additions & 0 deletions source/main/audio/SoundScriptManager.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@

namespace RoR {

/// @addtogroup Audio
/// @{

enum {
MAX_SOUNDS_PER_SCRIPT = 16,
MAX_INSTANCES_PER_GROUP = 256
Expand Down Expand Up @@ -319,6 +322,8 @@ class SoundScriptManager : public Ogre::ScriptLoader, public ZeroedMemoryAllocat
SoundManager* sound_manager;
};

/// @}

} // namespace RoR

#else // USE_OPENAL
Expand Down

0 comments on commit 87024e1

Please # to comment.