Difference between revisions of "UNO @since Tags"
From Apache OpenOffice Wiki
| Line 1: | Line 1: | ||
| − | OOo-related UNO documentation (i.e., for URE or SDK) uses <code>@since</code> tags for <code>autodoc</code> (C++, UNOIDL) and <code>javadoc</code> (Java) to specify that certain | + | OOo-related UNO documentation (i.e., for URE or SDK) uses <code>@since</code> tags for <code>autodoc</code> (C++, UNOIDL) and <code>javadoc</code> (Java) to specify that certain documented entities are only available from a given OOo or URE version onward. |
| − | documented entities are only available from a given OOo version onward. | + | |
| − | For UNOIDL documentation, the | + | For UNOIDL documentation, the <code>@since</code> tags are written “<code>@since OOo </code><var>x</var><code>.</code><var>y</var><code>.</code><var>z</var>” denoting OOo version <var>x</var>.<var>y</var>.<var>z</var>. |
| − | For C++ and Java documentation, the | + | For C++ and Java documentation, the <code>@since</code> tags are as follows: |
| − | + | ||
{| border=1 cellspacing=0 cellpadding=5 | {| border=1 cellspacing=0 cellpadding=5 | ||
| − | |||
| − | |||
| − | |||
| − | |||
| <code>@since UDK 3.0.1</code> | | <code>@since UDK 3.0.1</code> | ||
| − | | OOo 1.0.<var> | + | | OOo 1.0.<var>z</var> |
| − | + | ||
|- | |- | ||
| <code>@since UDK 3.1.0</code> | | <code>@since UDK 3.1.0</code> | ||
| − | | OOo 1.1.<var> | + | | OOo 1.1.<var>z</var> |
| − | + | ||
|- | |- | ||
| <code>@since UDK 3.2.0</code> | | <code>@since UDK 3.2.0</code> | ||
| OOo 2.0.0 | | OOo 2.0.0 | ||
| − | |||
|- | |- | ||
| <code>@since UDK 3.2.1</code> | | <code>@since UDK 3.2.1</code> | ||
| OOo 2.0.1 | | OOo 2.0.1 | ||
| − | |||
|- | |- | ||
| <code>@since UDK 3.2.2</code> | | <code>@since UDK 3.2.2</code> | ||
| + | | OOo 2.0.2 | ||
| + | |} | ||
| + | |||
| + | For reference, the relation between OOo versions and URE versions is as follows: | ||
| + | {| border=1 cellspacing=0 cellpadding=5 | ||
| + | | OOo 2.0.0 | ||
| + | | URE 1.0 | ||
| + | |- | ||
| OOo 2.0.2 | | OOo 2.0.2 | ||
| URE 1.1 | | URE 1.1 | ||
|} | |} | ||
| − | + | ||
| + | The information on this page will be updated over time. Also see http://www.openoffice.org/servlets/ReadMsg?list=dev&msgNo=12294 for further information. | ||
Revision as of 11:46, 17 January 2006
OOo-related UNO documentation (i.e., for URE or SDK) uses @since tags for autodoc (C++, UNOIDL) and javadoc (Java) to specify that certain documented entities are only available from a given OOo or URE version onward.
For UNOIDL documentation, the @since tags are written “@since OOo x.y.z” denoting OOo version x.y.z.
For C++ and Java documentation, the @since tags are as follows:
@since UDK 3.0.1
|
OOo 1.0.z |
@since UDK 3.1.0
|
OOo 1.1.z |
@since UDK 3.2.0
|
OOo 2.0.0 |
@since UDK 3.2.1
|
OOo 2.0.1 |
@since UDK 3.2.2
|
OOo 2.0.2 |
For reference, the relation between OOo versions and URE versions is as follows:
| OOo 2.0.0 | URE 1.0 |
| OOo 2.0.2 | URE 1.1 |
The information on this page will be updated over time. Also see http://www.openoffice.org/servlets/ReadMsg?list=dev&msgNo=12294 for further information.
