Commit 72ad96c8 authored by Diego Biurrun's avatar Diego Biurrun

doc/developer: Clarify symbol naming prefixes section.

parent fcf75022
...@@ -188,13 +188,16 @@ There are the following conventions for naming variables and functions: ...@@ -188,13 +188,16 @@ There are the following conventions for naming variables and functions:
@item @item
For local variables no prefix is required. For local variables no prefix is required.
@item @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 @item
For variables and functions used internally by a library an @code{ff_} For variables and functions visible outside of file scope, but only used
prefix should be used, e.g. @samp{ff_w64_demuxer}. internally by a library, an @code{ff_} prefix should be used,
e.g. @samp{ff_w64_demuxer}.
@item @item
For variables and functions used internally across multiple libraries, use For variables and functions visible outside of file scope, used internally
@code{avpriv_}. For example, @samp{avpriv_aac_parse_header}. across multiple libraries, use @code{avpriv_} as prefix, for example,
@samp{avpriv_aac_parse_header}.
@item @item
For externally visible symbols, each library has its own prefix. Check For externally visible symbols, each library has its own prefix. Check
the existing code and choose names accordingly. the existing code and choose names accordingly.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment