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/dev: clarify public symbols prefixes.

Browse Source
This commit is contained in:
Clément Bœsch 2013-02-13 20:19:32 +01:00
parent 5dd78ef34e
commit 15e7533ca1
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/developer.texi
View File

@ -165,8 +165,13 @@ prefix should be used, e.g. @samp{ff_w64_demuxer}.
For variables and functions used internally across multiple libraries, use For variables and functions used internally across multiple libraries, use
@code{avpriv_}. For example, @samp{avpriv_aac_parse_header}. @code{avpriv_}. For example, @samp{avpriv_aac_parse_header}.
@item @item
For externally visible symbols, each library has its own prefix. Check Each library has its own prefix for public symbols, in addition to the
the existing code and choose names accordingly. commonly used @code{av_} (@code{avformat_} for libavformat,
@code{avcodec_} for libavcodec, @code{swr_} for libswresample, etc).
Check the existing code and choose names accordingly.
Note that some symbols without these prefixes are also exported for
retro-compatibility reasons. These exceptions are declared in the
@code{lib<name>/lib<name>.v} files.
@end itemize @end itemize
Furthermore, name space reserved for the system should not be invaded. Furthermore, name space reserved for the system should not be invaded.