On Sat, Jun 8, 2013 at 3:42 AM, Ori Livneh <o...@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.
(quick, is it @param String $mystr or @param $myStr
> {string} ?)
It is @param [type] $param. I have referred to the output, and it is indeed
different. When Doxygen sees a type, it separates it from the parameter
description and adds styling and whatnot.
*-- *
*Tyler Romeo*
Stevens Institute of Technology, Class of 2016
Major in Computer Science
www.whizkidztech.com | tylerro...@gmail.com
_______________________________________________
Wikitech-l mailing list
Wikitech-l@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikitech-l
