This is the mail archive of the
gcc@gcc.gnu.org
mailing list for the GCC project.
RE: Doxygen for tree-ssa
- From: Bosscher Steven Civ USAFA/DFAN <Steven dot Bosscher at usafa dot af dot mil>
- To: "'Diego Novillo'" <dnovillo at redhat dot com>
- Cc: "'gcc at gcc dot gnu dot org'" <gcc at gcc dot gnu dot org>
- Date: Mon, 25 Nov 2002 10:49:17 -0700
- Subject: RE: Doxygen for tree-ssa
Hmm, this is extremely frustrating...
Stuff like this:
Partial references
------------------
To deal with arrays and structures, we use the concept of non-killing
definitions. When an array location or structure element is defined,
the SSA builder will consider that a partial definition of the array
itself. Partial definitions are modeled by keeping an SSA link
(def-def link) between the current definition and the previous one.
This is used to chain definitions to arrays and structures, so that all
possible reaching defs can be found later by compute_tree_rdefs. For
instance,
1 A[i] = 5;
2 A[j] = 10;
3 y = A[k] + 10;
looks *very* ugly in HTML. The "---" line is put right after "Partial
references", the example gets collapsed into a single line, etc... Not very
pretty. (I really miss an @example or @verbatim tag in Doxygen...)
The solution apparently is to use the <PRE> tag within the documentation.
Unfortunately, HTML tags are passed on to the HTML output only. So using
HTML tags means:
a) ugly tags in the source code
b) HTML output only, the rest would be useless
Do you want that, or should we just leave such elaborate documentation with
examples out of the Doxygen docs?
Greetz
Steven
-----Original Message-----
From: Diego Novillo [mailto:dnovillo@redhat.com]
Sent: Saturday, November 23, 2002 3:19 PM
To: Bosscher Steven Civ USAFA/DFAN
Subject: Re: Doxygen for tree-ssa
On Fri, 22 Nov 2002, Steven Bosscher wrote:
> I'm working from my machine at the USAF Academy, and I had some
> permissions-trouble installing doxygen & friends. You can probably
> understand how these things work in the military...
>
Heh, yeah, I can imagine :)
> Did you do some files already, and if so, have you committed that?
>
Nope. I hadn't started when I got your offer, so I haven't done
anything.
> Oh, by the way, thanks for pre-approving patches, but I don't have CVS
write
> access, so I'll just send stuff to gcc-patches.
>
Sure. Just send them to gcc-patches and I'll install them for
you.
Cheers. Diego.