Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
小白菜888
Ffmpeg
提交
f4888b83
F
Ffmpeg
项目概览
小白菜888
/
Ffmpeg
通知
3
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
F
Ffmpeg
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
f4888b83
编写于
7月 15, 2004
作者:
M
Michael Niedermayer
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Doxygen example
Originally committed as revision 3316 to
svn://svn.ffmpeg.org/ffmpeg/trunk
上级
a708785f
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
30 addition
and
2 deletion
+30
-2
doc/ffmpeg-doc.texi
doc/ffmpeg-doc.texi
+30
-2
未找到文件。
doc/ffmpeg-doc.texi
浏览文件 @
f4888b83
...
...
@@ -987,11 +987,39 @@ Main priority in ffmpeg is simplicity and small code size (=less
bugs).
Comments: use the JavaDoc/Doxygen
format (see examples
in @file
{
libavformat/utils.c
}
) so that a documentation
format (see examples
below
) so that a documentation
can be generated automatically. All non trivial functions should have a comment
above it explaining what the function does, even if its just one sentance.
All Structures and their member variables should be documented too.
@example
/**
* @file mpeg.c
* mpeg codec.
* @author ...
*/
/**
* Summary sentance.
* more text ...
* ...
*/
typedef struct Foobar
{
int var1; /**< var1 description */
int var2; ///< var2 description
/** var3 description */
int var3;
}
Foobar;
/**
* Summary sentance.
* more text ...
* ...
* @param my
_
parameter description of my
_
parameter
* @return return value description
*/
int myfunc(int my
_
parameter)
...
@end example
fprintf and printf are forbidden in libavformat and libavcodec,
please use av
_
log() instead.
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录