[Wikitech-l] Doxygen tags - a proposal

2013-06-08 Thread Ori Livneh
Earlier this evening I found myself gawking at a strange confusion of letters and symbols that had appeared in my editor. What are these symbols, and where do they come from? What secret geometry governs their arrangement? Just what is this, anyway? I sat and stared, perplexed. The symbols stared b

Re: [Wikitech-l] Doxygen tags - a proposal

2013-06-08 Thread Daniel Friesen
On Sat, 08 Jun 2013 00:42:40 -0700, Ori Livneh wrote: /** * Example * This file represents an example. * * @file * @ingroup examples * @comment * @tag */ Uhh, what extra meaning are @comment and @tag supposed to suggest? @file already indicates that this comment block defines metadat

Re: [Wikitech-l] Doxygen tags - a proposal

2013-06-08 Thread S Page
Perhaps Ori is pointing out that doxygen (and jsduck) require needless verbiage. The tools aren't smart enough to infer obvious information from source on their own (or maybe they are but you're not sure and you see other comments using these symbols so you copy and paste), so you wind up repeating

Re: [Wikitech-l] Doxygen tags - a proposal

2013-06-08 Thread Brian Wolff
On 2013-06-08 5:29 AM, "S Page" wrote: > > Perhaps Ori is pointing out that doxygen (and jsduck) require needless > verbiage. The tools aren't smart enough to infer obvious information from > source on their own (or maybe they are but you're not sure and you see > other comments using these symbol

Re: [Wikitech-l] Doxygen tags - a proposal

2013-06-08 Thread Tyler Romeo
On Sat, Jun 8, 2013 at 3:42 AM, Ori Livneh 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 Me

Re: [Wikitech-l] Doxygen tags - a proposal

2013-06-08 Thread Matthew Flaschen
On 06/08/2013 03:42 PM, Tyler Romeo wrote: > On Sat, Jun 8, 2013 at 3:42 AM, Ori Livneh 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 o

Re: [Wikitech-l] Doxygen tags - a proposal

2013-06-11 Thread Ori Livneh
On Sat, Jun 8, 2013 at 12:42 PM, Tyler Romeo wrote: > Doxygen will automatically realize that a file comment is a file comment. > You'd think so, but this appears to not be the case: http://noc.wikimedia.org/~olivneh/doxygen_testcases.tar.gz has four php files i'm guessing 1, 2 & 3 produce id

Re: [Wikitech-l] Doxygen tags - a proposal

2013-06-11 Thread Tim Starling
On 09/06/13 05:42, Tyler Romeo wrote: > On Sat, Jun 8, 2013 at 3:42 AM, Ori Livneh 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

Re: [Wikitech-l] Doxygen tags - a proposal

2013-06-12 Thread Tyler Romeo
On Wed, Jun 12, 2013 at 1:51 AM, Tim Starling wrote: > 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 > Interesting. Guess I was wrong. Sorry about that. *-- * *Tyler Romeo*