diff options
| author | Dimitri van Heesch <dimitri@stack.nl> | 2014-03-29 18:36:56 (GMT) |
|---|---|---|
| committer | Dimitri van Heesch <dimitri@stack.nl> | 2014-03-29 18:36:56 (GMT) |
| commit | 842c816a31537e32cec376c85c0a4363f74d7a54 (patch) | |
| tree | 03d6b185e875e40273478b0d1dd504345aec00ac /doc | |
| parent | a7c7f36ea2a67969bf3916c7600fe487e34438c0 (diff) | |
| download | Doxygen-842c816a31537e32cec376c85c0a4363f74d7a54.zip Doxygen-842c816a31537e32cec376c85c0a4363f74d7a54.tar.gz Doxygen-842c816a31537e32cec376c85c0a4363f74d7a54.tar.bz2 | |
Added optional [block] option to \htmlonly
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 15 | ||||
| -rw-r--r-- | doc/install.doc | 2 |
2 files changed, 11 insertions, 6 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 93a388b..4c3c2fc 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -2729,7 +2729,7 @@ class Receiver \sa section \ref cmdfcurlyopen "\\f{" and section \ref formulas "formulas". <hr> -\section cmdhtmlonly \\htmlonly +\section cmdhtmlonly \\htmlonly ["[block]"] \addindex \\htmlonly Starts a block of text that will be verbatim included in the @@ -2738,12 +2738,17 @@ class Receiver This command can be used to include HTML code that is too complex for doxygen (i.e. applets, java-scripts, and HTML tags that - require attributes). You can use the \ref cmdlatexonly "\\latexonly" and - \ref cmdendlatexonly "\\endlatexonly" - pair to provide a proper \f$\mbox{\LaTeX}\f$ alternative. + require specific attributes). + + Normally the contents between \ref cmdhtmlonly "\\htmlonly" and + \ref cmdendhtmlonly "\\endhtmlonly" is inserted as-is. When you + want to insert a HTML fragment that has block scope like a table or list + which should appear outside \<p\>..\</p\>, this can lead to invalid HTML. + You can use \\htmlonly[block] to make doxygen + end the current paragraph and restart it after \\endhtmlonly. \note environment variables (like \$(HOME) ) are resolved inside a - HTML-only block. + HTML-only block. \sa section \ref cmdmanonly "\\manonly", \ref cmdlatexonly "\\latexonly", diff --git a/doc/install.doc b/doc/install.doc index 150ff55..839b845 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -21,7 +21,7 @@ First go to the <a href="http://www.doxygen.org/download.html">download</a> page -to get the latest distribution, if you did not downloaded doxygen already. +to get the latest distribution, if you have not downloaded doxygen already. \section install_src_unix Compiling from source on UNIX |