summaryrefslogtreecommitdiff
path: root/udkapi
diff options
context:
space:
mode:
authorMichael Stahl <mstahl@redhat.com>2013-04-30 00:15:22 +0200
committerMichael Stahl <mstahl@redhat.com>2013-06-04 12:01:06 +0200
commit73d568408a150875b5c6046680f38e6db287c8fa (patch)
tree3c6d87ae03cc8193ef1d418d7a1ff7272bbbae53 /udkapi
parentb84bffc86a913383bb3fa7f9f3d963d32681f778 (diff)
*api: convert <listing> and @example
<listing> is called @code / @endcode in doxygen. @example requires a file name in doxygen. Also adapt various silly examples that use tools String in C++ or manual syntax highlighting in Java etc. Change-Id: I23cff1b688001f438526a6a1364cc5f754b504f7
Diffstat (limited to 'udkapi')
-rw-r--r--udkapi/com/sun/star/container/XContentEnumerationAccess.idl7
-rw-r--r--udkapi/com/sun/star/container/XEnumeration.idl9
-rw-r--r--udkapi/com/sun/star/lang/SystemDependent.idl8
3 files changed, 10 insertions, 14 deletions
diff --git a/udkapi/com/sun/star/container/XContentEnumerationAccess.idl b/udkapi/com/sun/star/container/XContentEnumerationAccess.idl
index 9e66a1200b12..50eee6d97d47 100644
--- a/udkapi/com/sun/star/container/XContentEnumerationAccess.idl
+++ b/udkapi/com/sun/star/container/XContentEnumerationAccess.idl
@@ -30,15 +30,14 @@ module com { module sun { module star { module container {
/** allows access to the collections of all content types within the object.
- @example
- <p>This example prints the names of all tables: </p>
+ <p>This example prints the names of all tables: </p>
- <listing>
+ @code{.bas}
xTextTableEnum = xTextDoc.createContentEnumeration( "com::sun::star::text::TextTable" )
while xTextTableEnum.hasMoreElements() do
print xTextTableEnum.nextElement().Name
wend
- </listing>
+ @endcode
*/
published interface XContentEnumerationAccess: com::sun::star::uno::XInterface
{
diff --git a/udkapi/com/sun/star/container/XEnumeration.idl b/udkapi/com/sun/star/container/XEnumeration.idl
index 288156fa9bff..48a46a6fd004 100644
--- a/udkapi/com/sun/star/container/XEnumeration.idl
+++ b/udkapi/com/sun/star/container/XEnumeration.idl
@@ -40,13 +40,12 @@ module com { module sun { module star { module container {
<p>For example (Java), to print all elements of a vector <var>aVect</var>:
</p>
- <listing>
- for ( XEnumeration xEnum = aVect.elements() ;
- xEnum.hasMoreElements() ; )
+ @code{.java}
+ for (XEnumeration xEnum = aVect.elements() ; xEnum.hasMoreElements() ; )
{
- System.out.println( xEnum.nextElement() );
+ System.out.println( xEnum.nextElement() );
}
- </listing>
+ @endcode
<p> If the object changed, the behavior of the enumeration is
diff --git a/udkapi/com/sun/star/lang/SystemDependent.idl b/udkapi/com/sun/star/lang/SystemDependent.idl
index 89447b467f59..1764eb98edd4 100644
--- a/udkapi/com/sun/star/lang/SystemDependent.idl
+++ b/udkapi/com/sun/star/lang/SystemDependent.idl
@@ -27,16 +27,14 @@ module com { module sun { module star { module lang {
<p> You should avoid system-dependent methods if possible.
- @example:C++
-
- <listing>
- #ifdef __WINDOW // Microsoft Windows
+ @code{.cpp}
+ #ifdef _WIN32 // Microsoft Windows
HWND hWin = (HWND)xInterface->getWindowHandle(SystemDependentWIN32);
if( hWin ) ...
#elif( ... ) // other systems
...
#endif
- </listing>
+ @endcode
<p>The Symbols are now prepended with SYSTEM_ thus we avoid collisions
with system headers. </p>