Permalink
Browse files

doc/developer: Clarify symbol naming prefixes section.

  • Loading branch information...
1 parent fcf7502 commit 72ad96c8544cff11b66fa3412023c6c535703f74 @DonDiego DonDiego committed Mar 16, 2013
Showing with 8 additions and 5 deletions.
  1. +8 −5 doc/developer.texi
View
@@ -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.

0 comments on commit 72ad96c

Please sign in to comment.