On Sat, Jun 8, 2013 at 3:42 AM, Ori Livneh
<ori(a)wikimedia.org> wrote:
@file
Of course! That's what this is -- a file! I wept with joy, and my heart
soared with gratitude for this humble Doxygen tag, without which the
ontology of our source code would be occult and irretrievable.
I should note that in MediaWiki's context this tag is useless. Doxygen will
automatically realize that a file comment is a file comment. The actual
purpose of the @file tag is if you have a project where you are
constructing your documentation in a different file than the actual source
code (yes, people do this). In other words, if all of your documentation is
in docs/hello.txt and you want to document another file docs/test.php, then
the @file tag should be used.
Both my testing and the Doxygen manual indicate that this is not the
case. If you omit the @file, then the relevant doc comment does not
appear in the generated HTML.
-- Tim Starling