This is the mail archive of the
gcc@gcc.gnu.org
mailing list for the GCC project.
Re: Thoughts on doxygen for internal documentation
- From: Joel Sherrill <joel dot sherrill at OARcorp dot com>
- To: Theodore Papadopoulo <Theodore dot Papadopoulo at sophia dot inria dot fr>
- Cc: law at redhat dot com, Diego Novillo <dnovillo at redhat dot com>, gcc at gcc dot gnu dot org
- Date: Thu, 16 Jan 2003 12:16:26 -0600
- Subject: Re: Thoughts on doxygen for internal documentation
- Organization: OAR Corporation
- References: <200301161803.h0GI3DYV018983@mururoa.inria.fr>
Theodore Papadopoulo wrote:
>
> law@redhat.com said:
> > I'll note that /** is contrary to the GNU coding standards.
I have used Doxygen on a recent project and must say that it is
pretty nifty. I know our customer was impressed by the D size
plotter printout of the object structure in the application.
It is a useful application. The only liability is that the GNU Project
has software in many languages and Doxygen does not support but
a handful of them.
> As an example, I always wondered why the rule of 80 columns is still
> that strict. IMHO often code can be more readable using longer lines
> (still with a reasonnable limit, just an higher one). Yes I know, some
> people still have a very old 80 columns VT100, but those cannot be
> that many ? Indeed, mail reader sometimes have this 80 limit constraints,
> but then problems with line wrapping by mailers happen also with 80
> columns... So why keeping this constraints and not updating it to
> something more sensible such as eg 132 colums.
Not to pick but I have been around a while now (first UNIX experience
around 1983) and haven't personally touched a real terminal in at least
7 years for any purpose. But 80 columns is still a reasonable
restriction
and we enforce it in my company's coding standards. Our Xterm's may
be any width we like but printing code that is wider than 80 columns
is troublesome. Yes you can reduce the font but that only makes it
harder to read.
Personally I like to use mpage to print 2 pages of program text to
a page at 80 columns wide.
> --------------------------------------------------------------------
> Theodore Papadopoulo
> Email: Theodore.Papadopoulo@sophia.inria.fr Tel: (33) 04 92 38 76 01
> --------------------------------------------------------------------
--
Joel Sherrill, Ph.D. Director of Research & Development
joel@OARcorp.com On-Line Applications Research
Ask me about RTEMS: a free RTOS Huntsville AL 35805
Support Available (256) 722-9985