On Tue, Nov 08, 2011 at 03:02:40PM +0100, 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..17dfd32 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.
> @code{///}
> +instead of @code{//!} and similar.
this is hard to comprehend, please add a verb to the 'i.e.':
"..., i.e. use @code{///} instead ..."
otherwise ok
Janne
_______________________________________________
libav-devel mailing list
[email protected]
https://lists.libav.org/mailman/listinfo/libav-devel
