ecore_audio: Add documentation for ecore_audio_obj_out

Signed-off-by: Daniel Willmann <d.willmann@samsung.com>

diff --git a/src/lib/ecore_audio/Ecore_Audio.h b/src/lib/ecore_audio/Ecore_Audio.h
index 3e7ed76..af1388e 100644 (file)
--- a/src/lib/ecore_audio/Ecore_Audio.h
+++ b/src/lib/ecore_audio/Ecore_Audio.h
@@ -36,6 +36,7 @@ extern "C"
    Ecore_Audio provides the following Eo classes:
    @li @ref ecore_audio_obj
    @li @ref ecore_audio_obj_in
+   @li @ref ecore_audio_obj_out
 
  * @since 1.8
  *

diff --git a/src/lib/ecore_audio/ecore_audio_obj_out.h b/src/lib/ecore_audio/ecore_audio_obj_out.h
index e42581f..0052545 100644 (file)
--- a/src/lib/ecore_audio/ecore_audio_obj_out.h
+++ b/src/lib/ecore_audio/ecore_audio_obj_out.h
@@ -20,7 +20,7 @@
 
 /**
  * @file ecore_audio_obj_out.h
- * @brief Audio Output Object
+ * @brief Ecore_Audio output object
  */
 
 #ifdef __cplusplus
@@ -29,12 +29,18 @@ extern "C"
 #endif
 
 /**
- * @addtogroup Ecore_Audio_Group
+ * @defgroup ecore_audio_obj_out - Ecore_Audio output object
+ * @ingroup Ecore_Audio_Group
  * @{
  */
 
-#define ECORE_AUDIO_OBJ_OUT_CLASS ecore_audio_obj_out_class_get()
+#define ECORE_AUDIO_OBJ_OUT_CLASS ecore_audio_obj_out_class_get() /**< Ecore_Audio output object class */
 
+/**
+ * @brief Get the Eo class ID
+ *
+ * @return The Eo class ID
+ */
 const Eo_Class *ecore_audio_obj_out_class_get() EINA_CONST;
 
 extern EAPI Eo_Op ECORE_AUDIO_OBJ_OUT_BASE_ID;
@@ -49,13 +55,35 @@ enum Ecore_Audio_Obj_Out_Sub_Ids
 
 #define ECORE_AUDIO_OBJ_OUT_ID(sub_id) (ECORE_AUDIO_OBJ_OUT_BASE_ID + EO_TYPECHECK(enum Ecore_Audio_Obj_Out_Sub_Ids, sub_id))
 
+/**
+ * @brief Attach an input to an output
+ *
+ * @since 1.8
+ *
+ * @param[in] input The input to attach to the output
+ * @param[out] ret EINA_TRUE if the input was attached, EINA_FALSE otherwise
+ */
 #define ecore_audio_obj_out_input_attach(input, ret) ECORE_AUDIO_OBJ_OUT_ID(ECORE_AUDIO_OBJ_OUT_SUB_ID_INPUT_ATTACH), EO_TYPECHECK(Eo *, input), EO_TYPECHECK(Eina_Bool *, ret)
 
+/**
+ * @brief Detach an input from an output
+ *
+ * @since 1.8
+ *
+ * @param[in] input The input to detach to the output
+ * @param[out] ret EINA_TRUE if the input was detached, EINA_FALSE otherwise
+ */
 #define ecore_audio_obj_out_input_detach(input, ret) ECORE_AUDIO_OBJ_OUT_ID(ECORE_AUDIO_OBJ_OUT_SUB_ID_INPUT_DETACH), EO_TYPECHECK(Eo *, input), EO_TYPECHECK(Eina_Bool *, ret)
 
-#define ecore_audio_obj_out_inputs_get(input) ECORE_AUDIO_OBJ_OUT_ID(ECORE_AUDIO_OBJ_OUT_SUB_ID_INPUTS_GET), EO_TYPECHECK(Eina_List **, input)
-
-
+/**
+ * @brief Detach an input from an output
+ *
+ * @since 1.8
+ *
+ * @param[out] inputs An @ref Eina_List of the inputs that are attached to
+ * the output
+ */
+#define ecore_audio_obj_out_inputs_get(inputs) ECORE_AUDIO_OBJ_OUT_ID(ECORE_AUDIO_OBJ_OUT_SUB_ID_INPUTS_GET), EO_TYPECHECK(Eina_List **, inputs)
 
 /**
  * @}