On Sun, Mar 06, 2011 at 01:21:31PM +1000, Jude wrote:
> On Sun, Mar 6, 2011 at 12:19 PM, Adam Borowski <kilob...@angband.pl> wrote:
> > /*
> > * File:
> > * Summary:
> > * Written by:
> > */
> >
> > What's the point of these? Especially the first and the last.
>
> None, as far as I'm aware. The summary is useful, but everything else is not.
> I think it would be a good idea to axe these or replace them with
> documentation in the Doxygen format.
> I see no reason why we can't replace this with:
>
> /**
> * @file
> * @section DESCRIPTION
> *
> * Contains monster death functionality, including Dowan and Duvessa,
> * Kirke, Pikel, shedu and spirits.
> **/
>
> This information is then interesting and used by Doxygen. I'm not sure
> if we need the @section line, but I'm pretty sure that Doxygen fetches
> these comments, parses them, and then presents them in pretty
> ?ML/LaTeX etc.
Could you tell me the final format to use?
There's 272 .cc files and 277 .h files, but fortunately most use something
that can be processed with a script.
--
1KB // Microsoft corollary to Hanlon's razor:
// Never attribute to stupidity what can be
// adequately explained by malice.
------------------------------------------------------------------------------
Colocation vs. Managed Hosting
A question and answer guide to determining the best fit
for your organization - today and in the future.
http://p.sf.net/sfu/internap-sfd2d
_______________________________________________
Crawl-ref-discuss mailing list
Crawl-ref-discuss@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/crawl-ref-discuss
