Kaydet (Commit) ccc4a67c authored tarafından Michael Stahl's avatar Michael Stahl

*api: fix bunch of lists that doxygen warns about

Change-Id: Ic507170e94d08155430601658689b3d7b96e0f80
üst 8a354334
......@@ -277,7 +277,7 @@ constants AccessibleEventId
<li>Unknown: when the type of text change or the place where it took
place can not be determined by the event broadcaster then both
fields remain empty. In this case the whole text may have changed
and the listener should refetch the text completely.</li> </ol>
and the listener should refetch the text completely.</li> </ul>
<p>When broadcasting an event always prefer the first three cases
to the last one. Use it only as a last resort.</p>
......
......@@ -60,13 +60,11 @@ service AccessibleList
Each child is of type com::sun::star::awt::AccessibleListItem. </li>
<li>Parent: The parent can be of type
<ul>
<li>
com::sun::star::awt::AccessibleComboBox
com::sun::star::awt::AccessibleListBox
com::sun::star::awt::AccessibleDropDownListBox
com::sun::star::awt::AccessibleDropDownComboBox
</li>
.
<li>com::sun::star::awt::AccessibleComboBox</li>
<li>com::sun::star::awt::AccessibleListBox</li>
<li>com::sun::star::awt::AccessibleDropDownListBox</li>
<li>com::sun::star::awt::AccessibleDropDownComboBox</li>
</ul>
</li>
<li>Relations: There are no relations.</li>
<li>States: The states supported by this service are
......
......@@ -94,7 +94,7 @@ published service PropertyBrowserController
<ul><li>Generic</li>
<li>Data</li>
<li>Events</li>
<ul></p>
</ul></p>
*/
[property] string CurrentPage;
......
......@@ -55,6 +55,7 @@
<li>After all applications have exited or a reasonable timeout the
session manager kills all remaining applications and finally lets the
desktop shut down.</li>
</ol>
*/
service SessionManager
{
......
......@@ -170,7 +170,7 @@ published interface XFrame: com::sun::star::lang::XComponent
@param aTargetFrameName
identify
<ul><li>(a) a special target ("_blank","_self" ...) or</li>
<li>(b) any well known frame</li><ul>
<li>(b) any well known frame</li></ul>
to search it inside the current hierarchy
@param nSearchFlags
......
......@@ -146,12 +146,14 @@ interface XDocumentMetadataAccess
<p>
This convenience method does the following:
<ol>
<li>import the given file into a graph with the given name
in the repository</li>
<li>insert statements declaring the new graph to be a
metadata file into the manifest graph</li>
<li>insert statements declaring <code>rdf:type</code> properties
for the new graph into the manifest graph</li>
</ol>
</p>
@param FileName
......@@ -201,9 +203,11 @@ interface XDocumentMetadataAccess
<p>
This convenience method does the following:
<ol>
<li>delete the graph with the given GraphName in the repository</li>
<li>remove the statements declaring the graph to be a
metadata file from the manifest graph</li>
</ol>
</p>
@param GraphName
......
......@@ -465,28 +465,25 @@ interface XCanvas : ::com::sun::star::uno::XInterface
Additional font properties to be applied when selecting this
font. Normally, you should not need this parameter. Currently,
the following properties are recognized:
<ul>
<li>Kerning: a double between 0 and 1, where
- Kerning: a double between 0 and 1, where
0 completely disables kerning. Whether kerning is on or
off by default is font-dependent.</li>
off by default is font-dependent.
<li>IsEmphasisMarks: a boolean, where `TRUE`
- IsEmphasisMarks: a boolean, where `TRUE`
enables automatic placements of emphasis marks, e.g. for
Hebrew. The default value, if this property is not
specified, is `FALSE`.</li>
specified, is `FALSE`.
<li>ExpandedSpacing: a double value which is added
- ExpandedSpacing: a double value which is added
between all cell distances for this font. The default value for
this property is zero. Use negative values for condensed output,
and positive values for expanded output.</li>
and positive values for expanded output.
<li>OptionalLayoutFeatures: a sequence of
- OptionalLayoutFeatures: a sequence of
::com::sun::star::beans::PropertyValue listing
font-specific optional layout features, like glyph
variants.</li>
</ul>
variants.
@param aFontMatrix
Font-specific transformation matrix, which affects both the
......
......@@ -51,10 +51,15 @@ interface XReportControlModel
/** Specifies which content should be shown.
The value can be <br/>
<li>the name of a database column. The format to use is field:[name] </li>
<li>the name of a function defined in the report or a group. The format to use is rpt:[functionName]</li>
<li>an expression like rpt:24+24-47</li>
The value can be
- the name of a database column.
The format to use is <code>field:[name]</code>
- the name of a function defined in the report or a group.
The format to use is <code>rpt:[functionName]</code>
- an expression like <code>rpt:24+24-47</code>
@see http://wiki.services.openoffice.org/wiki/SUN_Report_Builder
@see http://wiki.services.openoffice.org/wiki/SUN_Report_Builder#Syntax
@see http://wiki.services.openoffice.org/wiki/Base/Reports/Functions
......
......@@ -34,6 +34,7 @@ module com { module sun { module star { module sdb { module application {
/** describes a wizard which can be used to copy table like data from one
database to another.
<dl>
<dt><b><a name="interaction"></a>Interactions</b></dt>
<dd>
<p>There are various cases where the wizard needs to interact with the user (except of
......@@ -66,6 +67,7 @@ module com { module sun { module star { module sdb { module application {
in createWithInteractionHandler(). Only if there is no such interaction
handler, the processing described above, to find another handler, is applied.</p>
</dd>
</dl>
@see ::com::sun::star::sdb::ParametersRequest
@see XCopyTableWizard::addCopyTableListener
......
......@@ -81,13 +81,14 @@ service JDBCConnectionProperties
/** specifies how the type info returned by com::sun::star::sdbc::XDatabaseMetaData::getTypeInfo() will be modified.
<p>The sequence contains an even amount of string values. Each pair describes
<li>what should be searched for and </li>
<li>what should be replaced if found.</li>
what should be searched for and what should be replaced if found.
<br>
The syntax is:
<p>
<ul>
<li>COLUMN(2) = -5</li>
<li>COLUMN(6) = PRECISION</li>
</ul>
</p>
COLUMN(X) defines the column which will be compared and the column which will be replaced. In the example above column 2 will be compared
with the value -5. If this is true than column 6 will now return the value PRECISION.
......
......@@ -38,7 +38,7 @@ module com { module sun { module star { module ui {
<li><b>Type</b>a string that identifies a type of a user interface element.</li>
<li><b>Name</b>a string that identifies a single user interface element within a type class.</li>
<li><b>Module</b>a string that identifies a single module of OpenOffice.</li>
<ul>
</ul>
A combination of these three property values can uniquely identify every user interface
element within OpenOffice.
......
......@@ -94,7 +94,7 @@ published constants TemplateDescription
<ul>
<li>A checkbox "Read only"</li>
<li>A listbox "Version" for selecting a document version</li>
<ul>
</ul>
*/
const short FILEOPEN_READONLY_VERSION = 8;
......
......@@ -26,7 +26,8 @@ module com { module sun { module star { module util {
/** describes an RGB color value with an optional alpha channel.
<p>The byte order is from high to low:
<ol>alpha channel
<ol>
<li>alpha channel</li>
<li>red</li>
<li>green</li>
<li>blue</li>
......
......@@ -36,6 +36,7 @@ module com { module sun { module star { module xml { module sax {
<li>SAX = Simple API for XML </li>
<li>URI = Uniform Resource Identifier </li>
<li>DTD = document type definition </li>
</ul>
*/
published exception SAXException: com::sun::star::uno::Exception
{
......
......@@ -28,12 +28,11 @@ module com { module sun { module star { module beans {
/** This structure describes a property.
There are three types of properties:
- bound properties
- constrained properties
- free properties
<dl>There are three types of properties:
<dt>- bound properties</dt>
<dt>- constrained properties</dt>
<dt>- free properties</dt>
</dl>
*/
published struct Property
{
......
......@@ -43,7 +43,7 @@ module com { module sun { module star { module lang {
particular outgoing interface. </li>
</ul>
<h4>When to Implement?<h4>
<h4>When to Implement?</h4>
<p>To create a connectable object, you need to implement objects
that provide two related interfaces: </p>
......@@ -70,19 +70,16 @@ module com { module sun { module star { module lang {
<p>A client can use the XConnectionPointContainer interface: </p>
<UL>
- to get a sequence of connection points for each outgoing type.
<LI>to get a sequence of connection points for each outgoing type. </LI>
<LI>to obtain access to connection point sub-objects with the
- to obtain access to connection point sub-objects with the
XConnectionPoint interface for each
outgoing type. Through the XConnectionPoint interface,
a client starts or terminates an advisory loop with the
connectable object and the client's own sink. The
client can also use the XConnectionPoint
interface to get a sequence of the connections that it
knows about. </LI>
</UL>
knows about.
@see XConnectionPointContainer
*/
......
......@@ -31,8 +31,8 @@
the functions <code>open</code>, <code>close</code>, and <code>destroy</code>
from XSimpleRegistry are not supported and throw an exception
if they are used.
<dl>
<dt>Functions of XSimpleRegistry:
Functions of XSimpleRegistry:
<dl>
<dt> <b>getURL</b>
</dt>
......@@ -56,10 +56,7 @@
</dd>
</dl>
<br>
</dt>
<dt>Functions of XRegistryKey:
Functions of XRegistryKey:
<dl>
<dt> <b>openKey</b>
</dt>
......@@ -89,15 +86,11 @@
<dd> returns a sequence with the names of all subkeys in both registries.
</dd>
<dt>
<br>
<b>Note: all write functions only work on the local registry.</b>
</dt>
</dl>
<br>
</dt>
<dt>How to find the registries:
How to find the registries:
<dl>
<dt> search for the system registry:
</dt>
......@@ -109,23 +102,21 @@
<dt> Search for the user registry using the following rules:
</dt>
<dd>
<dl>
<dt> 1. (for further use) search in sversion.ini (.sversionrc) for an entry
<ol>
<li> 1. (for further use) search in sversion.ini (.sversionrc) for an entry
REGISTRY_VERSION_STRING (example: UserRegistry 5.0/505=test.rdb) in the section
[Registry]. If found, then take this value instead of "user.rdb" as "REGISTRY NAME".
</dt>
<dt> 2. Search in the config directory of the user for a file "REGISTRY NAME". If
</li>
<li> 2. Search in the config directory of the user for a file "REGISTRY NAME". If
found, return the full path and name of the file. If not found, retry this
step with a dot before "REGISTRY NAME".
</dt>
<dt> 3. If not found, a new user registry with name user.rdb will be created in the user
</li>
<li> 3. If not found, a new user registry with name user.rdb will be created in the user
config directory.
</dt>
</dl>
</li>
</ol>
</dd>
</dl>
</dt>
</dl>
<h4>Guarantees:</h4>
<ul>
......
......@@ -32,8 +32,8 @@
In the context of this service, the functions <code>open</code>, <code>close</code>,
and <code>destroy</code> from XSimpleRegistry are not supported and
throw an exception if they are used.
<dl>
<dt>Functions of XSimpleRegistry:
Functions of XSimpleRegistry:
<dl>
<dt> <b>getURL</b>
</dt>
......@@ -61,10 +61,7 @@
</dd>
</dl>
<br>
</dt>
<dt>Functions of XRegistryKey:
Functions of XRegistryKey:
<dl>
<dt> <b>openKey</b>
</dt>
......@@ -99,13 +96,10 @@
</dd>
<dt>
<br>
<b>Note: all write functions only work on registry1.</b>
</dt>
</dl>
</dt>
</dl>
<br>
How to initialize the registries:<br>
Use a sequence of XSimpleRegistry with two elements. The first element must be
the registry which is opened with read/write rights and the second element must be
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment