Add Doxyfile

Author: jackoalan

Doxyfile

@@ -1,4 +1,4 @@
-### Amuse
+### Amuse {#mainpage}
 
 **Amuse** is a real-time MIDI and SFX sequencer, with basic effects, 
 3D positional audio and surround-output capabilities.

README.md

@@ -12,6 +12,7 @@ class AudioGroupData;
 using Sample = std::pair<AudioGroupSampleDirectory::Entry,
                          AudioGroupSampleDirectory::ADPCMParms>;
 
+/** Runtime audio group index container */
 class AudioGroup
 {
     AudioGroupProject m_proj;

include/amuse/AudioGroup.hpp

@@ -4,9 +4,7 @@
 namespace amuse
 {
 
-/**
- * @brief Simple pointer-container of the four Audio Group chunks
- */
+/** Simple pointer-container of the four Audio Group chunks */
 class AudioGroupData
 {
 protected:
@@ -25,9 +23,7 @@ class AudioGroupData
     const unsigned char* getSamp() const {return m_samp;}
 };
 
-/**
- * @brief A buffer-owning version of AudioGroupData
- */
+/** A buffer-owning version of AudioGroupData */
 class IntrusiveAudioGroupData : public AudioGroupData
 {
     bool m_owns = true;

include/amuse/AudioGroupData.hpp

@@ -7,6 +7,7 @@
 namespace amuse
 {
 
+/** Indexes individual samples in SAMP chunk */
 class AudioGroupSampleDirectory
 {
     friend class AudioGroup;

include/amuse/AudioGroupSampleDirectory.hpp

@@ -10,6 +10,7 @@ class Voice;
 
 using Vector3f = float[3];
 
+/** Voice wrapper with positional-3D level control */
 class Emitter : public Entity
 {
     std::shared_ptr<Voice> m_vox;

include/amuse/Emitter.hpp

@@ -10,15 +10,6 @@ namespace amuse
 class Engine;
 class AudioGroup;
 
-enum class ObjectType : uint8_t
-{
-    Invalid = 0xff,
-    SoundMacro = 0,
-    Table = 1,
-    Kaymap = 4,
-    Layer = 8
-};
-
 /** Common ID structure statically tagging
  *  SoundMacros, Tables, Keymaps, Layers */
 using ObjectId = uint16_t;

include/amuse/Entity.hpp

@@ -15,9 +15,7 @@ enum class SubmixFormat
     Float
 };
 
-/**
- * @brief Client-implemented submix instance
- */
+/** Client-implemented submix instance */
 class IBackendSubmix
 {
 public:

include/amuse/IBackendSubmix.hpp

@@ -25,9 +25,7 @@ struct ChannelMap
     AudioChannel m_channels[8] = {};
 };
 
-/**
- * @brief Client-implemented voice instance
- */
+/** Client-implemented voice instance */
 class IBackendVoice
 {
 public:

include/amuse/IBackendVoice.hpp

@@ -20,9 +20,7 @@ enum class AudioChannelSet
     Unknown = 0xff
 };
 
-/**
- * @brief Client-implemented voice allocator
- */
+/** Client-implemented voice allocator */
 class IBackendVoiceAllocator
 {
 public:

include/amuse/IBackendVoiceAllocator.hpp

@@ -23,6 +23,7 @@ enum class SequencerState
     Dead /**< Set when arrangement complete and `dieOnEnd` was set, or manually with die() */
 };
 
+/** Multi-voice lifetime manager and polyphonic parameter tracking */
 class Sequencer : public Entity
 {
     friend class Engine;

include/amuse/Sequencer.hpp

@@ -17,7 +17,7 @@ enum class SongPlayState
     Playing
 };
 
-/** Indexes and temporally plays back commands stored in Song data blobs */
+/** Real-time state of Song execution */
 class SongState
 {
     friend class Voice;

include/amuse/SongState.hpp

@@ -10,6 +10,7 @@ namespace amuse
 {
 class Voice;
 
+/** Real-time state of SoundMacro execution */
 class SoundMacroState
 {
     friend class Voice;

include/amuse/SoundMacroState.hpp

@@ -9,6 +9,7 @@ namespace amuse
 {
 struct ReferenceVector;
 
+/** Support class for attenuating channel audio based on speaker 'positions' */
 class SurroundProfiles
 {
     static void SetupRefs(float matOut[8], const ChannelMap& map,