doc: document preferred Doxygen syntax and make patcheck detect it

[ffmpeg.git] / doc / developer.texi

diff --git a/doc/developer.texi b/doc/developer.texi
index a63bea7..c9cf7bd 100644 (file)
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -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.
 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
 @example
 /**
  * @@file