xenia-project/FFmpeg
1
0
Fork 0
mirror of https://github.com/xenia-project/FFmpeg.git synced 2024-11-24 12:09:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc/developer: Clarify symbol naming prefixes section.

Browse Source
This commit is contained in:
Diego Biurrun 2013-03-17 00:57:12 +01:00
parent fcf75022d7
commit 72ad96c854
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/developer.texi
View File

@ -188,13 +188,16 @@ There are the following conventions for naming variables and functions:
@item
For local variables no prefix is required.
@item
For variables and functions declared as @code{static} no prefix is required.
For file-scope variables and functions declared as @code{static}, no prefix
is required.
@item
For variables and functions used internally by a library an @code{ff_}
prefix should be used, e.g. @samp{ff_w64_demuxer}.
For variables and functions visible outside of file scope, but only 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}.
For variables and functions visible outside of file scope, used internally
across multiple libraries, use @code{avpriv_} as prefix, for example,
@samp{avpriv_aac_parse_header}.
@item
For externally visible symbols, each library has its own prefix. Check
the existing code and choose names accordingly.