X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fhtmlcmds.doc;h=01a1ea28a54bb746eeab7243534b511248d5b074;hb=14adf159fc9eb1212b2e61ea78e94c135abde0fe;hp=003297658c77dcfd7076d6ef79dc22081895181e;hpb=cfd886868fa8595b045007a2ad673c18c5f222b3;p=platform%2Fupstream%2Fdoxygen.git diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index 0032976..01a1ea2 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -26,104 +26,63 @@ of a HTML tag are passed on to the HTML output only
HTML Command | Description | ||
---|---|---|---|
\anchor htmltag_A_HREF \addindex "\"\ | Starts a hyperlink + | ||
\startalign\anchor htmltag_A_HREF \addindex "\"\endalign\ | Starts a hyperlink (if supported by the output format). | ||
\anchor htmltag_A_ID \addindex "\"\ | Starts a named anchor + | ||
\startalign\anchor htmltag_A_ID \addindex "\"\endalign\ | Starts a named anchor (if supported by the output format). | ||
\anchor htmltag_A_NAME \addindex "\"\ | Starts a named anchor + | ||
\startalign\anchor htmltag_A_NAME \addindex "\"\endalign\ | Starts a named anchor (if supported by the output format). | ||
\anchor htmltag_endA \addindex "\"\ | Ends a link or anchor | ||
\anchor htmltag_B \addindex "\"\ | Starts a piece of text displayed in a bold font. | ||
\anchor htmltag_endB \addindex "\"\ | Ends a \ref htmltag_B "\" section. | ||
\anchor htmltag_BLOCKQUOTE \addindex "\"\ | Starts a quotation block. | ||
\anchor htmltag_endBLOCKQUOTE \addindex "\"\ | Ends the quotation block. | ||
\anchor htmltag_BR \addindex "\ "\ | Forces a line break. | ||
\anchor htmltag_CENTER \addindex "\ | starts a section of centered text. | ||
\anchor htmltag_endCENTER \addindex "\"\ | ends a section of centered text. | ||
\anchor htmltag_CAPTION \addindex "\ | Starts a caption. Use within a table only. | ||
\anchor htmltag_endCAPTION \addindex "\"\ | Ends a caption. Use within a table only. | ||
\anchor htmltag_CITE \addindex "\"\ | Starts a section of text displayed in a font specific for citations. | ||
\anchor htmltag_endCITE \addindex "\"\ | Ends a \ref htmltag_CITE "\" section. | ||
\anchor htmltag_CODE \addindex "\"\ | Starts a piece of text displayed in a typewriter font. | ||
\startalign\anchor htmltag_endA \addindex "\"\endalign\ | Ends a link or anchor | ||
\startendhtmltag{B} | Starts and ends a piece of text displayed in a bold font. | ||
\startendhtmltag{BLOCKQUOTE} | Starts and ends a quotation block. | ||
\startalign\anchor htmltag_BR \addindex "\ "\endalign\ | Forces a line break. | ||
\startendhtmltag{CENTER} | Starts and ends a section of centered text. | ||
\startendhtmltag{CAPTION} | Starts and ends a caption. Use within a table only. | ||
\startendhtmltag{CITE} | Starts and ends a section of text displayed in a font specific for citations. | ||
\startendhtmltag{CODE} | Starts and ends a piece of text displayed in a typewriter font. | ||
\anchor htmltag_endCODE \addindex "\"\ | Ends a \ref htmltag_CODE "\" section.
- Note that only for C# code, this command is equivalent to
- \ref cmdendcode "\\endcode" (see \ref xmltag_code "\ | ||
\anchor htmltag_DD \addindex "\ | Starts an item description. | ||
\anchor htmltag_endDD \addindex "\"\ | Ends an item description. | ||
\anchor htmltag_DEL \addindex "\ | Starts a section of deleted text, typically shown strike through text. | ||
\anchor htmltag_endDEL \addindex "\"\ | Ends a section of deleted text. | ||
\anchor htmltag_DETAILS \addindex "\ "\ | Starts a section of detailed text that the user can open and close (in HTML output)) | ||
\anchor htmltag_endDETAILS \addindex "\"\ | Ends a section of detailed text. | ||
\anchor htmltag_DFN \addindex "\"\ | Starts a piece of text displayed in a typewriter font. | ||
\anchor htmltag_endDFN \addindex "\"\ | Ends a \ref htmltag_DFN "\" section. | ||
\anchor htmltag_DIV \addindex "\ "\ | Starts a section with a specific style (HTML only) | ||
\anchor htmltag_endDIV \addindex "\"\ | Ends a section with a specific style (HTML only) | ||
\anchor htmltag_DL \addindex "\
| Starts a description list. | ||
\anchor htmltag_endDL \addindex "\"\ | Ends a description list. | ||
\anchor htmltag_DT \addindex "\ | Starts an item title. | ||
\anchor htmltag_endDT \addindex "\"\ | Ends an item title. | ||
\anchor htmltag_EM \addindex "\"\ | Starts a piece of text displayed in an italic font. | ||
\anchor htmltag_endEM \addindex "\"\ | Ends a \ref htmltag_EM "\" section. | ||
\anchor htmltag_HR \addindex "\ "\ | Writes a horizontal ruler. | ||
\anchor htmltag_H1 \addindex "\"\ | Starts an unnumbered section. | ||
\anchor htmltag_endH1 \addindex "\"\ | Ends an unnumbered section. | ||
\anchor htmltag_H2 \addindex "\"\ | Starts an unnumbered subsection. | ||
\anchor htmltag_endH2 \addindex "\"\ | Ends an unnumbered subsection. | ||
\anchor htmltag_H3 \addindex "\"\ | Starts an unnumbered subsubsection. | ||
\anchor htmltag_endH3 \addindex "\"\ | Ends an unnumbered subsubsection. | ||
\anchor htmltag_H4 \addindex "\"\ | Starts an unnumbered subsubsection. | ||
\anchor htmltag_endH4 \addindex "\"\ | Ends an unnumbered subsubsection. | ||
\anchor htmltag_H5 \addindex "\"\ | Starts an unnumbered subsubsection. | ||
\anchor htmltag_endH5 \addindex "\"\ | Ends an unnumbered subsubsection. | ||
\anchor htmltag_H6 \addindex "\"\ | Starts an unnumbered subsubsection. | ||
\anchor htmltag_endH6 \addindex "\"\ | Ends an unnumbered subsubsection. | ||
\anchor htmltag_I \addindex "\"\ | Starts a piece of text displayed in an italic font. | ||
\anchor htmltag_endI \addindex "\"\ | Ends a \ref htmltag_I "\" section. | ||
\anchor htmltag_IMG \addindex "\ | This command is written with its attributes to the HTML output only. The SRC attribute is mandatory. | ||
\anchor htmltag_INS \addindex "\"\ | Starts a section of inserted text, typically shown as underlined text. | ||
\anchor htmltag_endINS \addindex "\"\ | Ends a section of inserted text. | ||
\anchor htmltag_LI \addindex "\ | Starts a new list item. | ||
\anchor htmltag_endLI \addindex "\"\ | Ends a list item. | ||
\anchor htmltag_OL \addindex "\
| Starts a numbered item list. | ||
\anchor htmltag_endOL \addindex "\"\ | Ends a numbered item list. | ||
\anchor htmltag_P \addindex "\ "\ | Starts a new paragraph. | ||
\anchor htmltag_endP \addindex "\"\ | Ends a paragraph. | ||
\anchor htmltag_PRE \addindex "\"\ | Starts a preformatted fragment. | ||
\anchor htmltag_endPRE \addindex "\"\ | Ends a preformatted fragment. | ||
\anchor htmltag_SMALL \addindex "\"\ | Starts a section of text displayed in a smaller font. | ||
\anchor htmltag_endSMALL \addindex "\"\ | Ends a \ref htmltag_SMALL "\" section. | ||
\anchor htmltag_SPAN \addindex "\"\ | Starts an inline text fragment with a specific style (HTML only) | ||
\anchor htmltag_endSPAN \addindex "\"\ | Ends an inline text fragment with a specific style (HTML only) | ||
\anchor htmltag_S \addindex "\ | Starts a section of strike through text. | ||
\anchor htmltag_endS \addindex "\"\ | Ends a section of strike through text. | ||
\anchor htmltag_STRIKE \addindex "\ | Starts a section of strike through text. | ||
\anchor htmltag_endSTRIKE \addindex "\"\ | Ends a section of strike through text. | ||
\anchor htmltag_STRONG \addindex "\"\ | Starts a section of bold text. | ||
\anchor htmltag_endSTRONG \addindex "\"\ | Ends a section of bold text. | ||
\anchor htmltag_SUB \addindex "\"\ | Starts a piece of text displayed in subscript. | ||
\anchor htmltag_endSUB \addindex "\"\ | Ends a \ref htmltag_SUB "\" section. | ||
\anchor htmltag_SUP \addindex "\"\ | Starts a piece of text displayed in superscript. | ||
\anchor htmltag_endSUP \addindex "\"\ | Ends a \ref htmltag_SUP "\" section. | ||
\anchor htmltag_TABLE \addindex "\
| ends a table. | ||
\anchor htmltag_TD \addindex "\"\ | Starts a new table data element. | | |
\anchor htmltag_endTD \addindex "\ | "\Ends a table data element. | ||
\anchor htmltag_TH \addindex "\"\ | | Starts a new table header. | |
\anchor htmltag_endTH \addindex "\"\ | Ends a table header. | ||
\anchor htmltag_TR \addindex "\Starts a new table row. | \anchor htmltag_endTR \addindex "\ | | Ends a table row. | -
\anchor htmltag_TT \addindex "\"\ | Starts a piece of text displayed in a typewriter font. | ||
\anchor htmltag_endTT \addindex "\"\ | Ends a \ref htmltag_TT "\" section. | ||
\anchor htmltag_KBD \addindex "\"\ | Starts a piece of text displayed in a typewriter font. | ||
\anchor htmltag_endKBD \addindex "\"\ | Ends a \ref htmltag_KBD "\" section. | ||
\anchor htmltag_U \addindex "\"\ | Starts a section of underlined text. | ||
\anchor htmltag_endU \addindex "\"\ | Ends a section of underlined text. | ||
\anchor htmltag_UL \addindex "\
| Starts an unnumbered item list. | ||
\anchor htmltag_endUL \addindex "\"\ | Ends an unnumbered item list. | ||
\anchor htmltag_VAR \addindex "\"\ | Starts a piece of text displayed in an italic font. | ||
\anchor htmltag_endVAR \addindex "\"\ | Ends a \ref htmltag_VAR "\" section. | ||
\startendhtmltag{DD} | Starts and ends an item description. | ||
\startendhtmltag{DEL} | Starts and ends a section of deleted text, typically shown as strike through text. | ||
\startendhtmltag{DETAILS} | Starts and ends a section of detailed text that the user can open and close (in HTML output)) | ||
\startendhtmltag{DFN} | Starts and ends a piece of text displayed in a typewriter font. | ||
\startendhtmltag{DIV} | Starts and ends a section with a specific style (HTML only) | ||
\startendhtmltag{DL} | Starts and ends a description list. | ||
\startendhtmltag{DT} | Starts and ends an item title. | ||
\startendhtmltag{EM} | Starts and ends a piece of text displayed in an italic font. | ||
\startalign\anchor htmltag_HR \addindex "\ "\endalign\ | Writes a horizontal ruler. | ||
\startendhtmltag{H1} | Starts and ends an unnumbered section. | ||
\startendhtmltag{H2} | Starts and ends an unnumbered subsection. | ||
\startendhtmltag{H3} | Starts and ends an unnumbered subsubsection. | ||
\startendhtmltag{H4} | Starts and ends an unnumbered subsubsection. | ||
\startendhtmltag{H5} | Starts and ends an unnumbered subsubsection. | ||
\startendhtmltag{H6} | Starts and ends an unnumbered subsubsection. | ||
\startendhtmltag{I} | Starts and ends a piece of text displayed in an italic font. | ||
\startalign\anchor htmltag_IMG \addindex "\ | This command is written with its attributes to the HTML output only. The SRC attribute is mandatory. | ||
\startendhtmltag{INS} | Starts and ends a section of inserted text, typically shown as underlined text. | ||
\startendhtmltag{KBD} | Starts and ends a piece of text displayed in a typewriter font. | ||
\startendhtmltag{LI} | Starts and ends a new list item. | ||
\startendhtmltag{OL} | Starts and ends a numbered item list. | ||
\startendhtmltag{P} | Starts and ends a new paragraph. | ||
\startendhtmltag{PRE} | Starts and ends a preformatted fragment. | ||
\startendhtmltag{S} | Starts and ends a section of strike through text. | ||
\startendhtmltag{SMALL} | Starts and ends a section of text displayed in a smaller font. | ||
\startendhtmltag{SPAN} | Starts and ends an inline text fragment with a specific style (HTML only) | ||
\startendhtmltag{STRIKE} | Starts and ends a section of strike through text. | ||
\startendhtmltag{STRONG} | Starts and ends a section of bold text. | ||
\startendhtmltag{SUB} | Starts and ends a piece of text displayed in subscript. | ||
\startendhtmltag{SUP} | Starts and ends a piece of text displayed in superscript. | ||
\startendhtmltag{TABLE} | Starts and ends a table. | ||
\startendhtmltag{TBODY} | Starts and ends a new table body, currently ignored by doxygen. | ||
\startendhtmltag{TD} | Starts and ends a new table data element. | ||
\startendhtmltag{TH} | Starts and ends a new table header. | ||
\startendhtmltag{THEAD} | Starts and ends a new table header, currently ignored by doxygen. | ||
\startendhtmltag{TFOOT} | Starts and ends a new table footer, currently ignored by doxygen. | ||
\startendhtmltag{TR} | Starts and ends a new table row. | ||
\startendhtmltag{TT} | Starts and ends a piece of text displayed in a typewriter font. | ||
\startendhtmltag{U} | Starts and ends a section of underlined text. | ||
\startendhtmltag{UL} | Starts and ends an unnumbered item list. | ||
\startendhtmltag{VAR} | Starts and ends a piece of text displayed in an italic font. |