| @@ -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 | 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. | above them explaining what the function does, even if it is just one sentence. | ||||
| All structures and their member variables should be documented, too. | 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 | @example | ||||
| /** | /** | ||||
| * @@file | * @@file | ||||
| @@ -55,6 +55,7 @@ hiegrep 'INIT_VLC_USE_STATIC' 'forbidden ancient vlc type' $* | |||||
| hiegrep '=[-+\*\&] ' 'looks like compound assignment' $* | hiegrep '=[-+\*\&] ' 'looks like compound assignment' $* | ||||
| hiegrep2 '/\*\* *[a-zA-Z0-9].*' '\*/' 'Inconsistently formatted doxygen comment' $* | hiegrep2 '/\*\* *[a-zA-Z0-9].*' '\*/' 'Inconsistently formatted doxygen comment' $* | ||||
| hiegrep '; */\*\*[^<]' 'Misformatted 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' $* | 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' $* | ||||