RE: [Doxygen-users] Formatting commands not being interpreted bet ween "..."

[James K. <jk...@ch...>]

|> > |> James KANZE wrote:
|> >
|> > |> > Appently, Doxygen escapes HTML meta-characters between double
|> > |> > quotes.  The result is that if I write something like
|> > |> > "<tt>abcd</tt>", that is exactly what appears in the displayed
|> > |> > HTML, Doxygen having converted it to
|> > |> > "&gt;tt&lt;abcd&gt;/tt&lt;". So how do I get it to output the
|> > |> > text within the quotes in typewriter font, with the quote
|> > |> > characters still in normal font?
|> >
|> > |> James, have you tried something like this "\<tt\>abcd\</tt\>" ?
|> >
|> > No help.  It escapes the \ as well.
|> >
|> > I don't understand it.  There are commands to tell it to force
|> > things to be taken literally.  If I wanted such escapes, I'd use
|> > them.  I presume, for example, that this is the difference
|> > between <tt>...</tt> and <code>...</code>.  The first simple
|> > uses a fixed width font, whereas the second adds the necessary
|> > escapes, so that my C++ code looks like it should, even if it
|> > contains things like < or & -- I agree that it would be pretty
|> > bad if taking the address of a variable named amp at the end of
|> > statement (e.g. <code>a =3D &amp;</code>) ended up interpreted as
|> > HTML.


|> Having seen several of your posts on the C++ newsgroups, I would
|> assume that you're a very experienced and intelligent developer.
|> So if this seems like a RTFM question, I apologize.  Have you
|> tried using \verbatim \endverbatim?  If so, what was the effect?

I haven't tried it, but the problem is just the reverse, I
think.  I *want* the <tt> and the </tt> to be interpreted, which
isn't happening.

I'm not sure from the documentation what exactly "\verbatim"
means, either.  Does it mean that the text will appear verbatim,
exactly as typed (on the screen and in the LaTeX document), or
does it mean that the browser and LaTeX will see the text
verbatim.  The first would probably be the more useful
interpretation, although the second could possibly serve here
(although I'd have to maintain two versions of the passage, one
for LaTeX, and one for HTML -- I *want* the <tt> to be
interpreted, as it would anywhere else).

Having gotten this far, I might ask a more general question.
The only documentation that I've seen consists of a very quick
tutorial (just enough to get you started), and a reference
manual (which requires you to have some idea of what the command
might be).  IMHO, this is simply not enough -- other systems for
generating text, like HTML or LaTeX, have complete books,
explaining in detail how to achieve various effects.  While it
is obviously too much to demand of Dimitri (I'm sure that just
maintaining Doxygen keeps him more than busy), something like
"The LaTeX Companion", but for Doxygen, would be extremely
useful.  Does anyone know of such a book?

--
James Kanze        GABI Software         mailto:jam...@fr...
Conseils en informatique orient=E9e objet/
                   Beratung in objektorientierter Datenverarbeitung
9 place S=E9mard, 78210 St.-Cyr-l'=C9cole, France, +33 (0)1 30 23 00 34

"This message, including any attachments may contain confidential and
privileged material; it is intended only for the person to whom it is
addressed. Its contents do not constitute a commitment by Credit Agricole
Cheuvreux except where provided for in a written agreement. Credit Agrico=
le
Cheuvreux assumes no liability or responsibility for the consequences
arising out of a delay and/or loss in transit of this message, or for
corruption or other error(s) arising in its transmission and for any misu=
se
or fraudulent use which may be made thereof. If you are not the intended
recipient, please contact us and abstain from any disclosure, use or
dissemination. To the extent that this message contains research
information and/or recommendations, these are provided on the same basis =
as
Credit Agricole Cheuvreux's published research and the recipient must hav=
e
regard to all disclosures and disclaimers contained therein."