diff options
author | Michael Niedermayer | 2013-03-22 12:52:05 +0100 |
---|---|---|
committer | Michael Niedermayer | 2013-03-22 12:58:22 +0100 |
commit | abbc34c372dbe8a486bfd5689b394b0af3835ef5 (patch) | |
tree | 982973d928bca6e3c36b9c3e5af7dbeed87d31de /doc/developer.texi | |
parent | 77f60f00111396b740bf44440f883010cc38514a (diff) | |
parent | 2e2ec667416d8ed345491ac360fccc94e7a4772f (diff) |
Merge remote-tracking branch 'qatar/master'
* qatar/master:
configure: Enable hwaccels without external dependencies by default.
doc/developer: Clarify symbol naming prefixes section.
Merged-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'doc/developer.texi')
-rw-r--r-- | doc/developer.texi | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/developer.texi b/doc/developer.texi index bd3f7a7413..baf7d20675 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -157,13 +157,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 Each library has its own prefix for public symbols, in addition to the commonly used @code{av_} (@code{avformat_} for libavformat, |