接口说明

说明

• 在C/C++中，函数一般在头文件中声明，实现写在源码文件中，编译后，调用者就看不到源码了，因此应该在头文件中对接口进行描述，以告知函数调用方式和一些额外信息。

常见描述信息

1. 函数名
2. 综合描述
3. 参数说明，输入和输出
4. 结果说明
5. 作者
6. 时间

自定义格式

/* 
\brief  decode h264 frame to jpg or yuv
\param  decode_type[in]         mh264_decode_type_yuv | mh264_decode_type_jpg
\param  h264_data[in]           h264 nal data. Include sps|pps|iframe
\param  h264_len[in]            h264_nal len
\param  buf[in]                 buf for result
\param  buf_len[out]         buf length|result len
\return the media channel
        # = 0                   ok
        # other                 fail
*/

* brief： 综合描述
* param： 参数说明，in表示输入，out表示输出
* return： 返回值

• 只包含必要信息，非必要信息按需添加。