aboutsummaryrefslogtreecommitdiff
path: root/doc/developer.texi
diff options
context:
space:
mode:
authorMichael Niedermayer2011-12-04 01:02:37 +0100
committerMichael Niedermayer2011-12-04 01:02:37 +0100
commit7f92f3d8129f44bc2ed935e9d81735ffdcd9921f (patch)
tree1b56b42bedce2ed6b28e629055be671be027e7b5 /doc/developer.texi
parentff53c79d0aefcef91e0a57125aeaffa08b326e56 (diff)
parentadedd840e20cbcf6b23b41d415581dc03bcce4c6 (diff)
Merge remote-tracking branch 'qatar/master'
* qatar/master: h264: fix frame reordering code. fate: Add a test for the VBLE decoder doc: break some long lines in developer.texi drawtext: make x and y parametric drawtext: manage memory allocation better drawtext: refactor draw_text doc: remove space between variable and post increment in example code Conflicts: doc/developer.texi doc/filters.texi libavcodec/h264.c libavfilter/vf_drawtext.c Merged-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'doc/developer.texi')
-rw-r--r--doc/developer.texi14
1 files changed, 9 insertions, 5 deletions
diff --git a/doc/developer.texi b/doc/developer.texi
index 50b4116999..2d3d418b97 100644
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -64,7 +64,8 @@ The TAB character is forbidden outside of Makefiles as is any
form of trailing whitespace. Commits containing either will be
rejected by the git repository.
@item
-You should try to limit your code lines to 80 characters; however, do so if and only if this improves readability.
+You should try to limit your code lines to 80 characters; however, do so if
+and only if this improves readability.
@end itemize
The presentation is one inspired by 'indent -i4 -kr -nut'.
@@ -144,6 +145,7 @@ All names are using underscores (_), not CamelCase. For example, @samp{avfilter_
a valid 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:
@itemize @bullet
@item
@@ -151,13 +153,15 @@ For local variables no prefix is required.
@item
For variables and functions declared as @code{static} no prefixes are required.
@item
-For variables and functions used internally by the library, @code{ff_} prefix should be used.
+For variables and functions used internally by the library, @code{ff_} prefix
+should be used.
For example, @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 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 exported names, each library has its own prefixes. Just check the existing
+code and name accordingly.
@end itemize
@subsection Miscellanous conventions