Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in / Register
Toggle navigation
F
ffmpeg
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
Packages
Packages
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
submodule
ffmpeg
Commits
def5dc12
Commit
def5dc12
authored
Nov 08, 2011
by
Diego Biurrun
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
doc: document preferred Doxygen syntax and make patcheck detect it
parent
dc6d0430
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
6 additions
and
0 deletions
+6
-0
developer.texi
doc/developer.texi
+5
-0
patcheck
tools/patcheck
+1
-0
No files found.
doc/developer.texi
View file @
def5dc12
...
...
@@ -105,6 +105,11 @@ Use the JavaDoc/Doxygen format (see examples below) so that code documentation
can be generated automatically. All nontrivial functions should have a comment
above them explaining what the function does, even if it is just one sentence.
All structures and their member variables should be documented, too.
Avoid Qt-style and similar Doxygen syntax with @code
{
!
}
in it, i.e. replace
@code
{
//!
}
with @code
{
///
}
and similar. Also @@ syntax should be employed
for markup commands, i.e. use @code
{
@@param
}
and not @code
{
\param
}
.
@example
/**
* @@file
...
...
tools/patcheck
View file @
def5dc12
...
...
@@ -55,6 +55,7 @@ hiegrep 'INIT_VLC_USE_STATIC' 'forbidden ancient vlc type' $*
hiegrep
'=[-+\*\&] '
'looks like compound assignment'
$*
hiegrep2
'/\*\* *[a-zA-Z0-9].*'
'\*/'
'Inconsistently formatted doxygen comment'
$*
hiegrep
'; */\*\*[^<]'
'Misformatted doxygen comment'
$*
hiegrep
'//!|/\*!'
'inconsistent doxygen syntax'
$*
hiegrep2
'(int|unsigned|static|void)[a-zA-Z0-9 _]*(init|end)[a-zA-Z0-9 _]*\(.*[^;]$'
'(av_cold|:\+[^a-zA-Z_])'
'These functions may need av_cold, please review the whole patch for similar functions needing av_cold'
$*
...
...
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