On Mon, 28 Nov 2011, Diego Biurrun wrote:
--- doc/developer.texi | 5 +++++ tools/patcheck | 1 + 2 files changed, 6 insertions(+), 0 deletions(-)diff --git a/doc/developer.texi b/doc/developer.texi index 800009e..fb60f23 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -90,6 +90,11 @@ 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}. +
This feels contradictory, if we should avoid syntax with ! in it, why would we replace '///' with '//!'?
// Martin _______________________________________________ libav-devel mailing list [email protected] https://lists.libav.org/mailman/listinfo/libav-devel
