git.videolan.org
/
ffmpeg.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
fcf7502
)
doc/developer: Clarify symbol naming prefixes section.
author
Diego Biurrun
<diego@biurrun.de>
Sat, 16 Mar 2013 23:57:12 +0000
(
00:57
+0100)
committer
Diego Biurrun
<diego@biurrun.de>
Thu, 21 Mar 2013 13:17:37 +0000
(14:17 +0100)
doc/developer.texi
patch
|
blob
|
history
diff --git
a/doc/developer.texi
b/doc/developer.texi
index
1a87859
..
cde87f1
100644
(file)
--- a/
doc/developer.texi
+++ b/
doc/developer.texi
@@
-188,13
+188,16
@@
There are the following conventions for naming variables and functions:
@item
For local variables no prefix is required.
@item
@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
@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
@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.
@item
For externally visible symbols, each library has its own prefix. Check
the existing code and choose names accordingly.