Re: [Doxygen-develop] Comment beginning with "// Author" suppresses doc generation
Brought to you by:
dimitri
From: Erik Z. <ze...@ma...> - 2013-02-16 16:10:32
|
On Sat, Feb 16, 2013 at 9:00 AM, dougkramer <dou...@gm...> wrote: > [cross-posted to doxygen-users] > > Has anyone else seen this? Should I submit a bug? Try the latest version first. The current version is 1.8.3.1. Erik > PROBLEM: > When I run doxygen on Objective-C source code with the following code block, > no documentation is generated for that method -- no signature, parameters or > doc comment. > > CAUSE: > I tracked the problem down to this: > A comment line that starts with the string "// Author" prevents entire > documentation for that method from being generated > > SOLUTION: > Add a word before "Author", such as "// The authorization has finished" > > ------------------------------------------------------------- > // A protocol implemented by the client. > @protocol MyClassDelegate > > // Authorization is finished > - (void)finishedWithAuth:(OAuth2Authentication *)auth; > > @end > -------------------------------------------------------------- > > $ doxygen --version > 1.7.6.1 > > > > -- > View this message in context: http://doxygen.10944.n7.nabble.com/Comment-beginning-with-Author-suppresses-doc-generation-tp5669.html > Sent from the Doxygen - Development mailing list archive at Nabble.com. > > ------------------------------------------------------------------------------ > The Go Parallel Website, sponsored by Intel - in partnership with Geeknet, > is your hub for all things parallel software development, from weekly thought > leadership blogs to news, videos, case studies, tutorials, tech docs, > whitepapers, evaluation guides, and opinion stories. Check out the most > recent posts - join the conversation now. http://goparallel.sourceforge.net/ > _______________________________________________ > Doxygen-develop mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-develop -- ************************************************* Erik Zeek ze...@ma... ************************************************* Against stupidity the very gods Themselves contend in vain. - Johann Christoph Friedrich von Schiller (1801) ************************************************* |