[Ffmpeg-devel] Correct place for Doxygen documentation

[Panagiotis Issaris]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi,

What is the policy regarding the placement of Doxygen comments? In the
.h or in the .c files?

I couldn't find anything on this in the documentation:
...
Comments: 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's just one sentence. All structures and their member
variables should be documented, too.
...

With friendly regards,
Takis
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFF3EPl9kOxLuzz4CkRAiodAJ9ggyChlCaY3YuRRf3yYsaYGEzL8wCeLQCh
KEVee+TZw0gmA98xJ03l3C8=
=yrf6
-----END PGP SIGNATURE-----