// // @page Private comments // // Lines beginning with "//#" are ignored, so you should not see the // "this should be invisible text below". // //# THIS SHOULD BE INVISIBLE // // @page HTML Formatting // // Basic formatting: bold, italic, underline, // superscript, subscript, teletype ("tt" tag), // font coloring: red, green, // blue, // font size: size 1, size 2, // size 3, // and all in one. // // "br" can be used for line breaks,
like
this (this paragraph should be 3 lines). // // Accented characters and special symbols: Tübingen, Gábor, // André, ampersand &, quote ". // But &gar-bage; and &n0th1ng; are left with & and ; marks. // // Tables can be drawn in HTML, as below. First line is heading. // // // // // // //
#number
1one
2two
3three
// // And there should be an 50% divider line below, drawn with HR: //
//
^^^ line
this text should be centered. //
// // Preformatted text ("pre" tag, should ideally be displayed in fixed-width font): //
// // C++ code example (body should be 4 spaces indented)
// for (i=0; i<10; i++)
// {
//     printf("<><><>"); // prints 3 angle brace pairs
//     cout << "2+3 > 4"; // C++ stream I/O
// }
// Indented text follows, with indent growing by 2 spaces:
//   HTML tags are interpreted, so this is italic.
//     - one
//       - two, in bold
//         - three
//           - 7 special characters: < > / \ & ; ^
// 
// // This text is after the pre tag. // // @page Divider // // Several hyphens produce a divider line, like the one below: // ----------------- // This text is after the divider. // // @page Non-HTML tags // // Non-HTML tags are not interpreted. // // <>foo should read: <>foo // (an empty tag, and "x", "yy" a d "zzz" tags, the first two unclosed.) // // An example XML document with "note", "to" and "title" tags, with the XML // declaration printed in italic and the values "Jack" and "Hello" in bold: // //
//   
//   
//     Jack
//     <b>Hello</b>
//   
// 
// // @page Escaping HTML tags // // The "nohtml" tag can be used to turn off interpreting html tags: // This
is not formatted
, // but this is! // // Printing "nohtml" itself: or </nohtml>. // // Backslash inside "nohtml": \ <== should display as a single backslash // // @page @ Tags // // Some @-tags (a`la Doxygen) are also supported: // // @author Andras @date 17/07/2004 // @todo more testing // @bug so far none noticed // @see manual // // @page Backslash handling // // Backslash handling: a single backslash should prevent hyperlinking a word. // So this should be hyperlinked: Formatting_1, but this not: \Formatting_1. // Single backslashes should also be removed, so none should be here: // \one,\Two, Th\ree. Double backslashes should become one, so you should // see one \\here, another here: \\, and two here: \\\\. // package org.omnetpp.neddoc;