diff options
Diffstat (limited to 'doc/htmlcmds.doc')
| -rw-r--r-- | doc/htmlcmds.doc | 158 |
1 files changed, 79 insertions, 79 deletions
diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index 476be78..7f79852 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -23,96 +23,96 @@ documentation. Note that all attributes of a HTML tag are ignored <ul> <li><tt>\<A HREF="..."\></tt> Starts a HTML hyper-link (HTML only). <li><tt>\<A NAME="..."\></tt> Starts an named anchor (HTML only). -<li>\c </A> Ends a link or anchor (HTML only). -<li>\c <B> Starts a piece of text displayed in a bold font. -<li>\c </B> Ends a \c <B> section. -<li>\c <BODY> Does not generate any output. -<li>\c </BODY> Does not generate any output. -<li>\c <BR> Forces a line break. -<li>\c <CENTER> starts a section of centered text. -<li>\c </CENTER> ends a section of centered text. -<li>\c <CAPTION> Starts a caption. Use within a table only. -<li>\c </CAPTION> Ends a caption. Use within a table only. -<li>\c <CODE> Starts a piece of text displayed in a typewriter font. -<li>\c </CODE> End a \c <CODE> section. -<li>\c <DD> Starts an item description. -<li>\c <DFN> Starts a piece of text displayed in a typewriter font. -<li>\c </DFN> Ends a \c <DFN> section. -<li>\c <DL> Starts a description list. -<li>\c </DL> Ends a description list. -<li>\c <DT> Starts an item title. -<li>\c </DT> Ends an item title. -<li>\c <EM> Starts a piece of text displayed in an italic font. -<li>\c </EM> Ends a \c <EM> section. -<li>\c <FORM> Does not generate any output. -<li>\c </FORM> Does not generate any output. -<li>\c <HR> Writes a horizontal ruler. -<li>\c <H1> Starts an unnumbered section. -<li>\c </H1> Ends an unnumberd section. -<li>\c <H2> Starts an unnumbered subsection. -<li>\c </H2> Ends an unnumbered subsection. -<li>\c <H?> Where ? is one of {3,4,5,6}, starts an unnumbered subsubsection using \c <H3> in HTML. -<li>\c </H?> Where ? is one of {3,4,5,6}, ends an unnumbered subsubsection using \c <H3> in HTML. -<li>\c <I> Starts a piece of text displayed in an italic font. -<li>\c <INPUT> Does not generate any output. -<li>\c </I> Ends a \c <I> section. -<li>\c <IMG> This command is written with attributes to the HTML output only. -<li>\c <LI> Starts a new list item. -<li>\c </LI> Ends a list item. -<li>\c <META> Does not generate any output. -<li>\c <MULTICOL> ignored by doxygen. -<li>\c </MUTLICOL> ignored by doxygen. -<li>\c <OL> Starts a numbered item list. -<li>\c </OL> Ends a numbered item list. -<li>\c <P> Starts a new paragraph. -<li>\c </P> Ends a paragraph. -<li>\c <PRE> Starts a preformatted fragment. -<li>\c </PRE> Ends a preformatted fragment. -<li>\c <SMALL> Starts a section of text displayed in a smaller font. -<li>\c </SMALL> Ends a \c <SMALL> section. -<li>\c <STRONG> Starts a section of bold text. -<li>\c </STRONG> Ends a section of bold text. -<li>\c <SUB> Starts a piece of text displayed in subscript. -<li>\c </SUB> Ends a \c <SUB> section. -<li>\c <SUP> Starts a piece of text displayed in superscript. -<li>\c </SUP> Ends a \c </SUP> section. -<li>\c <TABLE> starts a table. -<li>\c </TABLE> ends a table. -<li>\c <TD> Starts a new table data element. -<li>\c </TD> Ends a table data element. -<li>\c <TR> Starts a new table row. -<li>\c </TR> Ends a table row. -<li>\c <TT> Starts a piece of text displayed in a typewriter font. -<li>\c </TT> Ends a \c <TT> section. -<li>\c <KBD> Starts a piece of text displayed in a typewriter font. -<li>\c </KBD> Ends a \c <KBD> section. -<li>\c <UL> Starts an unnumbered item list. -<li>\c </UL> Ends an unnumbered item list. -<li>\c <VAR> Starts a piece of text displayed in an italic font. -<li>\c </VAR> Ends a \c </VAR> section. +<li><tt>\</A></tt> Ends a link or anchor (HTML only). +<li><tt>\<B></tt> Starts a piece of text displayed in a bold font. +<li><tt>\</B></tt> Ends a <tt>\<B\></tt> section. +<li><tt>\<BODY></tt> Does not generate any output. +<li><tt>\</BODY></tt> Does not generate any output. +<li><tt>\<BR></tt> Forces a line break. +<li><tt>\<CENTER></tt> starts a section of centered text. +<li><tt>\</CENTER></tt> ends a section of centered text. +<li><tt>\<CAPTION></tt> Starts a caption. Use within a table only. +<li><tt>\</CAPTION></tt> Ends a caption. Use within a table only. +<li><tt>\<CODE></tt> Starts a piece of text displayed in a typewriter font. +<li><tt>\</CODE></tt> End a <tt>\<CODE\></tt> section. +<li><tt>\<DD></tt> Starts an item description. +<li><tt>\<DFN></tt> Starts a piece of text displayed in a typewriter font. +<li><tt>\</DFN></tt> Ends a <tt>\<DFN\></tt> section. +<li><tt>\<DL></tt> Starts a description list. +<li><tt>\</DL></tt> Ends a description list. +<li><tt>\<DT></tt> Starts an item title. +<li><tt>\</DT></tt> Ends an item title. +<li><tt>\<EM></tt> Starts a piece of text displayed in an italic font. +<li><tt>\</EM></tt> Ends a <tt>\<EM\></tt> section. +<li><tt>\<FORM></tt> Does not generate any output. +<li><tt>\</FORM></tt> Does not generate any output. +<li><tt>\<HR></tt> Writes a horizontal ruler. +<li><tt>\<H1></tt> Starts an unnumbered section. +<li><tt>\</H1></tt> Ends an unnumberd section. +<li><tt>\<H2></tt> Starts an unnumbered subsection. +<li><tt>\</H2></tt> Ends an unnumbered subsection. +<li><tt>\<H3></tt> Starts an unnumbered subsubsection. +<li><tt>\</H3></tt> Ends an unnumbered subsubsection. +<li><tt>\<I></tt> Starts a piece of text displayed in an italic font. +<li><tt>\<INPUT></tt> Does not generate any output. +<li><tt>\</I></tt> Ends a <tt>\<I\></tt> section. +<li><tt>\<IMG></tt> This command is written with attributes to the HTML output only. +<li><tt>\<LI></tt> Starts a new list item. +<li><tt>\</LI></tt> Ends a list item. +<li><tt>\<META></tt> Does not generate any output. +<li><tt>\<MULTICOL></tt> ignored by doxygen. +<li><tt>\</MUTLICOL></tt> ignored by doxygen. +<li><tt>\<OL></tt> Starts a numbered item list. +<li><tt>\</OL></tt> Ends a numbered item list. +<li><tt>\<P></tt> Starts a new paragraph. +<li><tt>\</P></tt> Ends a paragraph. +<li><tt>\<PRE></tt> Starts a preformatted fragment. +<li><tt>\</PRE></tt> Ends a preformatted fragment. +<li><tt>\<SMALL></tt> Starts a section of text displayed in a smaller font. +<li><tt>\</SMALL></tt> Ends a <tt>\<SMALL\></tt> section. +<li><tt>\<STRONG></tt> Starts a section of bold text. +<li><tt>\</STRONG></tt> Ends a section of bold text. +<li><tt>\<SUB></tt> Starts a piece of text displayed in subscript. +<li><tt>\</SUB></tt> Ends a <tt>\<SUB\></tt> section. +<li><tt>\<SUP></tt> Starts a piece of text displayed in superscript. +<li><tt>\</SUP></tt> Ends a <tt>\</SUP\></tt> section. +<li><tt>\<TABLE></tt> starts a table. +<li><tt>\</TABLE></tt> ends a table. +<li><tt>\<TD></tt> Starts a new table data element. +<li><tt>\</TD></tt> Ends a table data element. +<li><tt>\<TR></tt> Starts a new table row. +<li><tt>\</TR></tt> Ends a table row. +<li><tt>\<TT></tt> Starts a piece of text displayed in a typewriter font. +<li><tt>\</TT></tt> Ends a <tt>\<TT\></tt> section. +<li><tt>\<KBD></tt> Starts a piece of text displayed in a typewriter font. +<li><tt>\</KBD></tt> Ends a <tt>\<KBD\></tt> section. +<li><tt>\<UL></tt> Starts an unnumbered item list. +<li><tt>\</UL></tt> Ends an unnumbered item list. +<li><tt>\<VAR></tt> Starts a piece of text displayed in an italic font. +<li><tt>\</VAR></tt> Ends a <tt>\</VAR\></tt> section. </ul> The special HTML character entities that are recognized by Doxygen: <ul> -<li>\c © the copyright symbol -<li>\c " a double quote -<li>\c &?uml; where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, +<li><tt>\©</tt> the copyright symbol +<li><tt>\"</tt> a double quote +<li><tt>\&?uml;</tt> where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, writes a character with a diaeresis accent (like ä). -<li>\c &?acute; where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, +<li><tt>\&?acute;</tt> where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, writes a character with a acute accent (like á). -<li>\c &?grave; where ? is one of {A,E,I,O,U,a,e,i,o,u,y}, +<li><tt>\&?grave;</tt> where ? is one of {A,E,I,O,U,a,e,i,o,u,y}, writes a character with a grave accent (like à). -<li>\c &?circ; where ? is one of {A,E,I,O,U,a,e,i,o,u,y}, +<li><tt>\&?circ;</tt> where ? is one of {A,E,I,O,U,a,e,i,o,u,y}, writes a character with a circumflex accent (like â). -<li>\c &?tilde; where ? is one of {A,N,O,a,n,o}, +<li><tt>\&?tilde;</tt> where ? is one of {A,N,O,a,n,o}, writes a character with a tilde accent (like ã). -<li>\c ß write a sharp s (i.e. ß) to the output. -<li>\c &?cedil; where ? is one of {c,C}, +<li><tt>\ß</tt> write a sharp s (i.e. ß) to the output. +<li><tt>\&?cedil;</tt> where ? is one of {c,C}, writes a c-cedille (like ç). -<li>\c &?ring; where ? is one of {a,A}, - writes an \c a with a ring (like å). -<li>\c a non breakable space. +<li><tt>\&?ring;</tt> where ? is one of {a,A}, + writes an <tt>a</tt> with a ring (like å). +<li><tt>\ </tt> a non breakable space. </ul> Finally, to put invisible comments inside comment blocks, HTML style |