!740 audio NDK易用性整改

Merge pull request !740 from zhangkai/master

multimedia/audio_framework/common/native_audio_common.h

@@ -54,42 +54,42 @@ extern "C" {
  */
 typedef enum {
     /**
-     * @brief The call was successful.
+     * @error The call was successful.
      */
     AUDIOCOMMON_RESULT_SUCCESS = 0,
 
     /**
-     * @brief This means that the input parameter is invalid.
+     * @error This means that the input parameter is invalid.
      */
     AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM = 6800101,
 
     /**
-     * @brief This means there is no memory left.
+     * @error This means there is no memory left.
      */
     AUDIOCOMMON_RESULT_ERROR_NO_MEMORY = 6800102,
 
     /**
-     * @brief Execution status exception.
+     * @error Execution status exception.
      */
     AUDIOCOMMON_RESULT_ERROR_ILLEGAL_STATE = 6800103,
 
     /**
-     * @brief This means the operation is unsupported.
+     * @error This means the operation is unsupported.
      */
     AUDIOCOMMON_RESULT_ERROR_UNSUPPORTED = 6800104,
 
     /**
-     * @brief This means the operation is timeout.
+     * @error This means the operation is timeout.
      */
     AUDIOCOMMON_RESULT_ERROR_TIMEOUT = 6800105,
 
     /**
-     * @brief This means reached stream limit.
+     * @error This means reached stream limit.
      */
     AUDIOCOMMON_RESULT_ERROR_STREAM_LIMIT = 6800201,
 
     /**
-     * @brief An system error has occurred.
+     * @error An system error has occurred.
      */
     AUDIOCOMMON_RESULT_ERROR_SYSTEM = 6800301,
 } OH_AudioCommon_Result;

multimedia/audio_framework/common/native_audiostream_base.h

@@ -45,34 +45,34 @@ extern "C" {
 #endif
 
 /**
- * Define the result of the function execution.
+ * @brief Define the result of the function execution.
  *
  * @since 10
  */
 typedef enum {
     /**
-     * The call was successful.
+     * @error The call was successful.
      *
      * @since 10
      */
     AUDIOSTREAM_SUCCESS = 0,
 
     /**
-     * This means that the function was executed with an invalid input parameter.
+     * @error This means that the function was executed with an invalid input parameter.
      *
      * @since 10
      */
     AUDIOSTREAM_ERROR_INVALID_PARAM = 1,
 
     /**
-     * Execution status exception.
+     * @error Execution status exception.
      *
      * @since 10
      */
     AUDIOSTREAM_ERROR_ILLEGAL_STATE = 2,
 
     /**
-     * An system error has occurred.
+     * @error An system error has occurred.
      *
      * @since 10
      */
@@ -80,7 +80,7 @@ typedef enum {
 } OH_AudioStream_Result;
 
 /**
- * Define the audio stream type.
+ * @brief Define the audio stream type.
  *
  * @since 10
  */
@@ -101,7 +101,7 @@ typedef enum {
 } OH_AudioStream_Type;
 
 /**
- * Define the audio stream sample format.
+ * @brief Define the audio stream sample format.
  *
  * @since 10
  */
@@ -133,7 +133,7 @@ typedef enum {
 } OH_AudioStream_SampleFormat;
 
 /**
- * Define the audio encoding type.
+ * @brief Define the audio encoding type.
  *
  * @since 10
  */
@@ -153,7 +153,7 @@ typedef enum {
 } OH_AudioStream_EncodingType;
 
 /**
- * Define the audio stream usage.
+ * @brief Define the audio stream usage.
  * Audio stream usage is used to describe what work scenario
  * the current stream is used for.
  *
@@ -247,7 +247,7 @@ typedef enum {
 } OH_AudioStream_Usage;
 
 /**
- * Define the audio latency mode.
+ * @brief Define the audio latency mode.
  *
  * @since 10
  */
@@ -267,7 +267,7 @@ typedef enum {
 } OH_AudioStream_LatencyMode;
 
 /**
- * Define the audio event.
+ * @brief Define the audio event.
  *
  * @since 10
  */
@@ -281,7 +281,7 @@ typedef enum {
 } OH_AudioStream_Event;
 
 /**
- * The audio stream states
+ * @brief The audio stream states
  *
  * @since 10
  */
@@ -331,7 +331,7 @@ typedef enum {
 } OH_AudioStream_State;
 
 /**
- * Defines the audio interrupt type.
+ * @brief Defines the audio interrupt type.
  *
  * @since 10
  */
@@ -351,7 +351,7 @@ typedef enum {
 } OH_AudioInterrupt_ForceType;
 
 /**
- * Defines the audio interrupt hint type.
+ * @brief Defines the audio interrupt hint type.
  *
  * @since 10
  */
@@ -395,7 +395,7 @@ typedef enum {
 } OH_AudioInterrupt_Hint;
 
 /**
- * Defines the audio source type.
+ * @brief Defines the audio source type.
  *
  * @since 10
  */
@@ -455,7 +455,7 @@ typedef enum {
 } OH_AudioStream_AudioEffectMode;
 
 /**
- * Defines the audio interrupt mode.
+ * @brief Defines the audio interrupt mode.
  *
  * @since 12
  */
@@ -471,7 +471,7 @@ typedef enum {
 } OH_AudioInterrupt_Mode;
 
 /**
- * Declaring the audio stream builder.
+ * @brief Declaring the audio stream builder.
  * The instance of builder is used for creating audio stream.
  *
  * @since 10
@@ -479,7 +479,7 @@ typedef enum {
 typedef struct OH_AudioStreamBuilderStruct OH_AudioStreamBuilder;
 
 /**
- * Declaring the audio renderer stream.
+ * @brief Declaring the audio renderer stream.
  * The instance of renderer stream is used for playing audio data.
  *
  * @since 10
@@ -487,7 +487,7 @@ typedef struct OH_AudioStreamBuilderStruct OH_AudioStreamBuilder;
 typedef struct OH_AudioRendererStruct OH_AudioRenderer;
 
 /**
- * Declaring the audio capturer stream.
+ * @brief Declaring the audio capturer stream.
  * The instance of renderer stream is used for capturing audio data.
  *
  * @since 10
@@ -495,7 +495,7 @@ typedef struct OH_AudioRendererStruct OH_AudioRenderer;
 typedef struct OH_AudioCapturerStruct OH_AudioCapturer;
 
 /**
- * Declaring the callback struct for renderer stream.
+ * @brief Declaring the callback struct for renderer stream.
  *
  * @since 10
  */
@@ -548,7 +548,7 @@ typedef struct OH_AudioRenderer_Callbacks_Struct {
 } OH_AudioRenderer_Callbacks;
 
 /**
- * Declaring the callback struct for capturer stream.
+ * @brief Declaring the callback struct for capturer stream.
  *
  * @since 10
  */