RepoMirrors
/
ffmpeg
mirror of https://git.ffmpeg.org/ffmpeg.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc: developer: Fix wording in "naming conventions" section

This commit is contained in:
Diego Biurrun 2013-02-11 18:39:12 +01:00
parent 69dca3a4f4
commit 56dea32f09
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/developer.texi
View File

@ -178,27 +178,26 @@ GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
@end itemize
@subsection Naming conventions
All names are using underscores (_), not CamelCase. For example,
@samp{avfilter_get_video_buffer} is a valid function name and
@samp{AVFilterGetVideo} is not. The only exception from this are structure
names; they should always be in the CamelCase
All names should be composed with underscores (_), not CamelCase. For example,
@samp{avfilter_get_video_buffer} is an acceptable function name and
@samp{AVFilterGetVideo} is not. The only exception are structure
names; they should always be CamelCase.
There are following conventions for naming variables and functions:
There are the following conventions for naming variables and functions:
@itemize @bullet
@item
For local variables no prefix is required.
@item
For variables and functions declared as @code{static} no prefixes are required.
For variables and functions declared as @code{static} no prefix is required.
@item
For variables and functions used internally by the library, @code{ff_} prefix
should be used.
For example, @samp{ff_w64_demuxer}.
For variables and functions used internally by a library an @code{ff_}
prefix should be used, e.g. @samp{ff_w64_demuxer}.
@item
For variables and functions used internally across multiple libraries, use
@code{avpriv_}. For example, @samp{avpriv_aac_parse_header}.
@item
For exported names, each library has its own prefixes. Just check the existing
code and name accordingly.
For externally visible symbols, each library has its own prefix. Check
the existing code and choose names accordingly.
@end itemize
@subsection Miscellaneous conventions