summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMichael Niedermayer <michaelni@gmx.at>2013-02-12 13:41:24 +0100
committerMichael Niedermayer <michaelni@gmx.at>2013-02-12 13:41:24 +0100
commit08db519e1275d301417be0013ef3eb03e9381935 (patch)
tree72419e876bc2704d69a3643a0dca62d50f574f5a /doc
parent7491356111e7f171b6cd4f23a8d8fb32439485ca (diff)
parent56dea32f09e71460add14a1b6d0fbe6eb16f02a4 (diff)
Merge commit '56dea32f09e71460add14a1b6d0fbe6eb16f02a4'
* commit '56dea32f09e71460add14a1b6d0fbe6eb16f02a4': doc: developer: Fix wording in "naming conventions" section openbsd: Add minor number to shared library install name Conflicts: doc/developer.texi Merged-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'doc')
-rw-r--r--doc/developer.texi19
1 files changed, 9 insertions, 10 deletions
diff --git a/doc/developer.texi b/doc/developer.texi
index eaf5980145..1c29ae0e14 100644
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -147,27 +147,26 @@ GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
@end itemize
@subsection Naming conventions
-All names are using underscores (_), not CamelCase. For example, @samp{avfilter_get_video_buffer} is
-a valid function name and @samp{AVFilterGetVideo} is not. The exception from this are type names, like
+All names should be composed with underscores (_), not CamelCase. For example,
+@samp{avfilter_get_video_buffer} is an acceptable function name and
+@samp{AVFilterGetVideo} is not. The exception from this are type names, like
for example structs and enums; they should always be in the CamelCase
-
-There are following conventions for naming variables and functions:
+There are the following conventions for naming variables and functions:
@itemize @bullet
@item
For local variables no prefix is required.
@item
-For variables and functions declared as @code{static} no prefixes are required.
+For variables and functions declared as @code{static} no prefix is required.
@item
-For variables and functions used internally by the library, @code{ff_} prefix
-should be used.
-For example, @samp{ff_w64_demuxer}.
+For variables and functions 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}.
@item
-For exported names, each library has its own prefixes. Just check the existing
-code and name accordingly.
+For externally visible symbols, each library has its own prefix. Check
+the existing code and choose names accordingly.
@end itemize
@subsection Miscellaneous conventions