diff --git a/core/AmAdvancedAudio.h b/core/AmAdvancedAudio.h index afe0a6ad..53629822 100644 --- a/core/AmAdvancedAudio.h +++ b/core/AmAdvancedAudio.h @@ -36,6 +36,9 @@ using namespace std; #include "SampleArray.h" +/** + * \brief Entry in an AudioQueue + */ struct AudioQueueEntry { AmAudio* audio; bool put; @@ -45,8 +48,9 @@ struct AudioQueueEntry { }; /** - * AmAudioQueue can hold AmAudios in input and output queue. + * \brief Holds AmAudios and reads/writes through all * + * AmAudioQueue can hold AmAudios in input and output queue. * Audio will be read through the whole output queue, * and written through the whole input queue. */ diff --git a/core/AmApi.h b/core/AmApi.h index dafbed4c..c1090eec 100644 --- a/core/AmApi.h +++ b/core/AmApi.h @@ -38,11 +38,12 @@ using std::map; using std::string; /** - * Multi-purpose plugin class + * \brief interface of the DynInvoke API */ class AmDynInvoke { public: + /** \brief NotImplemented result for DI API calls */ struct NotImplemented { string what; NotImplemented(const string& w) @@ -55,7 +56,7 @@ public: }; /** - * Base class for plugin factories + * \brief Base interface for plugin factories */ class AmPluginFactory { @@ -79,7 +80,10 @@ public: }; /** - * Factory for multi-purpose plugin classes + * \brief Interface of factory for plugins that provide a DI API + * + * Factory for multi-purpose plugin classes, + * classes that provide a DynInvoke (DI) API */ class AmDynInvokeFactory: public AmPluginFactory { @@ -91,7 +95,9 @@ public: class AmSession; class AmSessionEventHandler; - +/** + * \brief Interface for PluginFactories that can handle events in sessions + */ class AmSessionEventHandlerFactory: public AmPluginFactory { public: @@ -105,7 +111,7 @@ public: virtual bool onInvite(const AmSipRequest& req)=0; }; - +/** \brief Interface for plugins to create sessions */ class AmSessionFactory: public AmPluginFactory { diff --git a/core/AmArg.h b/core/AmArg.h index fb0157ce..331e3d54 100644 --- a/core/AmArg.h +++ b/core/AmArg.h @@ -6,6 +6,7 @@ #include using std::vector; +/** \brief variable type argument for DynInvoke APIs */ class AmArg { public: @@ -64,6 +65,7 @@ public: const char* asCStr() const { return v_cstr; } }; +/** \brief array of variable args for DI APIs*/ class AmArgArray { vector v; diff --git a/core/AmAudio.h b/core/AmAudio.h index d090ccc6..30ce1cf3 100644 --- a/core/AmAudio.h +++ b/core/AmAudio.h @@ -42,6 +42,7 @@ using std::string; #define PCM16_B2S(b) ((b) >> 1) #define PCM16_S2B(s) ((s) << 1) +/** \brief Audio Event */ class AmAudioEvent: public AmEvent { public: @@ -88,7 +89,7 @@ struct amci_subtype_t; class AmAudio; /** - * Audio format structure. + * \brief Audio format structure. * Holds a description of the format. * @todo Create two child class: *