Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Contribute to GitLab
Sign in / Register
Toggle navigation
F
ffmpeg.wasm-core
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Linshizhi
ffmpeg.wasm-core
Commits
56dea32f
Commit
56dea32f
authored
Feb 11, 2013
by
Diego Biurrun
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
doc: developer: Fix wording in "naming conventions" section
parent
69dca3a4
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
10 additions
and
11 deletions
+10
-11
developer.texi
doc/developer.texi
+10
-11
No files found.
doc/developer.texi
View file @
56dea32f
...
...
@@ -178,27 +178,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 only exception
from this
are structure
names; they should always be
in the CamelCase
All names
should be composed with
underscores (
_
), not CamelCase. For example,
@samp
{
avfilter
_
get
_
video
_
buffer
}
is a
n acceptable
function name and
@samp
{
AVFilterGetVideo
}
is not. The only exception are structure
names; they should always be
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 prefix
es 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 ex
ported names, each library has its own prefixes. Just check the existing
code and name
accordingly.
For ex
ternally visible symbols, each library has its own prefix. Check
the existing code and choose names
accordingly.
@end itemize
@subsection Miscellaneous conventions
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment