[Freeciv-Dev] Re: Code commentary proposal (by A. Sutton)

[Petr Baudis <pasky@xxxxxxxxxxx>]

Dear diary, on Mon, Dec 03, 2001 at 04:26:32PM CET, I got a letter, where
Gregory Berkolaiko <gberkolaiko@xxxxxxxxxxx> told me, that...
> Please send your comments to the list and/or Andrew <ansutton@xxxxxxx>, I am
> just a publisher (although highly supportive of the proposal).  Broken links
> should be reported to me, of course.
I like that! However doxygen seems to be a bit too large and complex for me.
IMHO we would be able to survive with even something much smaller and
lightweight, like 'kernel-doc' - GPL'ed perl script taking the format mentioned
in Andrew's document, but it has only 45kb and can be easily shipped along with
the mainline distribution (source-code obviously :). For those who don't happen
to have /usr/src/linux/scripts/kernel-doc, I copied it to
http://pasky.ji.cz/~pasky/cp/kernel-doc. The only disadvantage obvious to me
at the first sight is missing support for /**< ... */.

I would only propose to change the prefix from /** to
/**********************************************************************
this is actually used in the freeciv code and keeping this will result in
smaller diffs, higher lucidity and happier Raimar ;).

-- 

                                Petr "Pasky" Baudis

UN*X programmer, UN*X administrator, hobbies = IPv6, IRC, FreeCiv hacking
.
  "A common mistake that people make, when trying to design
   something completely foolproof is to underestimate the
   ingenuity of complete fools."
     -- Douglas Adams in Mostly Harmless
.
Public PGP key, geekcode and stuff: http://pasky.ji.cz/~pasky/