|
|
|
@@ -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 |
|
|
|
|