diff -r 000000000000 -r 42188c7ea2d9 Orb/Doxygen/doc/DITA/DoxygenDITAEditionUserGuideSource/concepts/examples.dita --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Orb/Doxygen/doc/DITA/DoxygenDITAEditionUserGuideSource/concepts/examples.dita Thu Jan 21 17:29:01 2010 +0000 @@ -0,0 +1,204 @@ + + + + Examples + + This is a brief description of what can be expected in the DITA output. + + + Other output formats will greatly differ from the DITA output as not all tags have been implemented in the C++ DITA specialisation so far. See the Supported Doxygen Commands document for a list of commands supported in the DITA output. It is recommended that only supported commands are used when writing in source comments destined to go into DITA output. + +
+ code and endcode

Use \code and \endcode to enclose code examples.

+ + + + + + + In Source + + \code +if ( firstEnabled == -1 ) + firstEnabled = ii ;http://lohdr001.europe.nokia.com/ +if ( aPlugInArray[ii]->DisplayName().FindF( aPreferredSupplier ) == KErrNotFound ) + aPlugInArray[ii]->SetDisabled( ETrue ) ; +else + matchCount++ ; +\endcode + + + + DITA Output + + <codeblock>if ( firstEnabled == -1 ) + firstEnabled = ii ;http://lohdr001.europe.nokia.com/ +if ( aPlugInArray[ii]->DisplayName().FindF( aPreferredSupplier ) == KErrNotFound ) + aPlugInArray[ii]->SetDisabled( ETrue ) ; +else + matchCount++ ;</codeblock> + + + + +
+
+
+ leave

A \leave tag is transformed into two seperate paragraphs, one that contains the text "leave" and another that contains the content after the \leave tag.

+ + + + + + + In Source + + \leave KErrNoMemory - insufficient free memory for object creation when decoding parts + + + + DITA Output + + <p><b>leave</b></p> + <p>KErrNoMemory - insufficient free memory for object creation when decoding parts </p> + + + + +
+
+
+ li

\li tag items are transformed into DITA <li> elements within an unordered list <ul>. The \li tags are non nestable.

+ + + + + + + In Source + + \li apples +\li bananas +\li bacon + + + + DITA Output + + <ul> + <li> + <p>apples </p> + </li> + <li> + <p>bananas </p> + </li> + <li> + <p>bacon</p> + </li> +</ul> + + + + +
+
+
+ note

\note is transformed into a DITA <note> element with the type attribute equaling "note".

+ + + + + + + In Source + + \note It's raining, use an umbrella. + + + + + DITA Output + + <note type="note"> + <p>It's raining, use an umbrella. </p> +</note> + + + + +
+
+
+ par

The \par tag can take a title, the line afterwards is the actual parapraph. The title is optional and can be omited by leaving the first line blank and entering the paragraph on the line below the \par tag.

+ + + + + + + In Source + + /** + \par Paragraph Title + Paragraph contents. +*/ + + + + DITA Output + + <p> + <b>Paragraph Title</b> +</p> +<p>Paragraph contents.</p> + + + + + +
+
+ +
+ verbatim and endverbatim

Text within \verbatim and \endverbatim tags will be reproduced in DITA exactly as it appeared in the source.

+ + + + + + + In Source + + \verbatim + typedef struct + { + double x; + double y; + double z; + char * name; + int namelength; + } point3d; +\endverbatim + + + + DITA Output + + <p><pre> + typedef struct + { + double x; + double y; + double z; + char * name; + int namelength; + } point3d; + </pre></p> + + + + +
+
+ +