diff options
author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-11-30 17:27:16 +0100 |
---|---|---|
committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-11-30 17:27:16 +0100 |
commit | b8194e02679dc88f5c0a240da83a4700ec5200cf (patch) | |
tree | 216e2e28793fce2d468b23fa9b5d2a17db32012b /src/crepe/api | |
parent | 9eff2e24fa4cf0ffad2b47cc922a6558bc1a9fa1 (diff) |
add doxygen comments + clean up
Diffstat (limited to 'src/crepe/api')
-rw-r--r-- | src/crepe/api/AudioSource.h | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/src/crepe/api/AudioSource.h b/src/crepe/api/AudioSource.h index 63b4bc4..330e8e1 100644 --- a/src/crepe/api/AudioSource.h +++ b/src/crepe/api/AudioSource.h @@ -17,16 +17,19 @@ class AudioSource : public Component { friend class AudioSystem; protected: + /** + * \param source Sound sample to load + */ AudioSource(game_object_id_t id, const Asset & source); - //! Only ComponentManager can create components + //! Only ComponentManager creates components friend class ComponentManager; public: - // But std::unique_ptr needs to be able to destoy this component again + // std::unique_ptr needs to be able to destoy this component virtual ~AudioSource() = default; public: - //! Start or resume this audio source + //! Start this audio source void play(bool looping = false); //! Stop this audio source void stop(); |