diff options
author | Michael Stahl <mstahl@redhat.com> | 2013-04-27 21:47:17 +0200 |
---|---|---|
committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:00:59 +0200 |
commit | 944eb9902788d8afec9e3f0f65d3b680041e039b (patch) | |
tree | 3bbb926890561b81d9f6ae611be4677876799a36 /offapi/com/sun/star/sdb | |
parent | cdbbbdce9956e290b4a849af332df55da1be8d36 (diff) |
*api: convert <type>Foo</type>
Doxygen does not know type element and will recognize strings that
contain capital letter (all API types do) automatically as type.
This patch removes 15k doxygen warnings.
git ls-files | grep \\.idl | xargs sed -i "s,<type>\([^<]\+\)</type>,\1,"
Change-Id: I45c07cf0b115d5fb5353f4aa9719839615ea1150
Diffstat (limited to 'offapi/com/sun/star/sdb')
34 files changed, 75 insertions, 75 deletions
diff --git a/offapi/com/sun/star/sdb/BooleanComparisonMode.idl b/offapi/com/sun/star/sdb/BooleanComparisonMode.idl index d8e63d7fc175..0234e736ec6e 100644 --- a/offapi/com/sun/star/sdb/BooleanComparisonMode.idl +++ b/offapi/com/sun/star/sdb/BooleanComparisonMode.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module sdb { /** specifies different mode how boolean comparison predicates are to be generated - by a <type>SingleSelectQueryComposer</type>. + by a SingleSelectQueryComposer. */ constants BooleanComparisonMode { diff --git a/offapi/com/sun/star/sdb/ColumnDescriptorControlModel.idl b/offapi/com/sun/star/sdb/ColumnDescriptorControlModel.idl index 4b99e3e2a0c9..dfaa66af893d 100644 --- a/offapi/com/sun/star/sdb/ColumnDescriptorControlModel.idl +++ b/offapi/com/sun/star/sdb/ColumnDescriptorControlModel.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module sdb { -/** specifies the standard model of an <type>ColumnDescriptorControl</type>. +/** specifies the standard model of an ColumnDescriptorControl. */ service ColumnDescriptorControlModel { diff --git a/offapi/com/sun/star/sdb/DataAccessDescriptor.idl b/offapi/com/sun/star/sdb/DataAccessDescriptor.idl index 59b308f2cdd1..066894d750c5 100644 --- a/offapi/com/sun/star/sdb/DataAccessDescriptor.idl +++ b/offapi/com/sun/star/sdb/DataAccessDescriptor.idl @@ -36,7 +36,7 @@ module com { module sun { module star { module sdb { The <code>DataAccessDescriptor</code> describes the super set of the properties for the most common data access objects.</p> - <p>Every component providing or requiring a <type>DataAccessDescriptor</type> for some functionality + <p>Every component providing or requiring a DataAccessDescriptor for some functionality is urged to specify which properties are mandatory, and which ones optional. Additionally, it's free to specify any additional requirements about the relations of properties.</p> @@ -46,7 +46,7 @@ published service DataAccessDescriptor { /** specifies the name of the datasource to access. - <p>This data source is usually used to create a <type>Connection</type>. If no DataSourceName is given + <p>This data source is usually used to create a Connection. If no DataSourceName is given and the <member>DatabaseLocation</member> and the <member>ConnectionResource</member> are empty, then an <member>ActiveConnection</member> is required.</p> @@ -57,7 +57,7 @@ published service DataAccessDescriptor /** specifies the URL of the database file. - <p>This database location is usually used to create a <type>Connection</type>. If no DatabaseLocation is given + <p>This database location is usually used to create a Connection. If no DatabaseLocation is given and the <member>ConnectionResource</member> is empty, then an <member>ActiveConnection</member> is required.</p> @see com::sun::star::sdb::DatabaseContext @@ -67,7 +67,7 @@ published service DataAccessDescriptor /** specifies the database URL which locates a database driver. - <p>This database URL is usually used to create a <type>Connection</type>. If no ConnectionResource is given, + <p>This database URL is usually used to create a Connection. If no ConnectionResource is given, then an <member>ActiveConnection</member> is required.</p> @see com::sun::star::sdb::DatabaseContext @@ -89,10 +89,10 @@ published service DataAccessDescriptor /** is a connection to use. <p>This object is guaranteed to be a <type scope="com::sun::star::sdbc">Connection</type>, but usually - it will be a <type>Connection</type> from the module com::sun::star::sdb.<br/> + it will be a Connection from the module com::sun::star::sdb.<br/> Especially in the case where no <member>DataSourceName</member> is given, but <member>CommandType</member> is <member>CommandType::QUERY</member>, the ActiveConnection needs - to fully support the <type>Connection</type> service, to actually retrieve the query specified by + to fully support the Connection service, to actually retrieve the query specified by <member>Command</member></p> <p>If no ActiveConnection is given, then a <member>DataSourceName</member> is required.</p> @@ -128,7 +128,7 @@ published service DataAccessDescriptor <code>WHERE</code>-string itself.</p> <p>If a <member>DataSourceName</member>, <member>Command</member> and <member>CommandType</member> - are specified, a <type>RowSet</type> can be created with this information. If the results provided by the + are specified, a RowSet can be created with this information. If the results provided by the row set are to be additionally filtered, the Filter property can be used.</p> <p>Note that the Filter property does not make sense if a <member>ResultSet</member> has been specified @@ -241,7 +241,7 @@ published service DataAccessDescriptor with the <member>ColumnName</member> property.</p> <p>The object will at least support the <type scope="com::sun::star::sdbcx">Column</type> service, but more - often it will even be a <type>Column</type> from the com::sun::star::sdb module.</p> + often it will even be a Column from the com::sun::star::sdb module.</p> */ [optional, property] com::sun::star::beans::XPropertySet Column; }; diff --git a/offapi/com/sun/star/sdb/DataSource.idl b/offapi/com/sun/star/sdb/DataSource.idl index de6ab1e7b425..6944d7604551 100644 --- a/offapi/com/sun/star/sdb/DataSource.idl +++ b/offapi/com/sun/star/sdb/DataSource.idl @@ -58,7 +58,7 @@ published service DataSource interface XCompletedConnection; /** useful for establishing isolated connections which are not shared among others - as it is the case when using <type>XCompletedConnection</type> or <type scope="com::sun::star::sdbc">XDataSource</type>. + as it is the case when using XCompletedConnection or <type scope="com::sun::star::sdbc">XDataSource</type>. @see XCompletedConnection @see com::sun::star::sdbc::XDataSource @since OOo 1.1.2 @@ -119,7 +119,7 @@ published service DataSource /** is a list of arbitrary string tag/value pairs as connection arguments - <p>The <type>DataSource</type> itself does not attempt to interpret any of those values.</p> + <p>The DataSource itself does not attempt to interpret any of those values.</p> <p>Instead, the values in this property have two use cases: <ul><li>Upon creating a connection, for every value in this sequence it's checked diff --git a/offapi/com/sun/star/sdb/DataSourceBrowser.idl b/offapi/com/sun/star/sdb/DataSourceBrowser.idl index fdd4519930cb..8cab0c7c8d9b 100644 --- a/offapi/com/sun/star/sdb/DataSourceBrowser.idl +++ b/offapi/com/sun/star/sdb/DataSourceBrowser.idl @@ -118,7 +118,7 @@ module com { module sun { module star { module sdb { </li> </ul> </p> - <p>For all kinds of URLs, the parameters supplied during dispatching build up a <type>DataAccessDescriptor</type>, + <p>For all kinds of URLs, the parameters supplied during dispatching build up a DataAccessDescriptor, where the following properties are present: <ul> <li><member>DataAccessDescriptor::DataSourceName</member></li> @@ -176,11 +176,11 @@ published service DataSourceBrowser plug the browser component into.</li> <li><b>DataSourceName</b><br/> - The name of the globally registered <type>DataSource</type> to be used for initial display. It is only + The name of the globally registered DataSource to be used for initial display. It is only meaningful together with the other parameters specifying the object to display.</li> <li><b>CommandType</b><br/> - This has to be a <type>CommandType</type> value, specifying the type of the object to display initially. + This has to be a CommandType value, specifying the type of the object to display initially. It is only meaningful together with the <em>DataSourceName</em> and the <em>Command</em> parameters.</li> <li><b>Command</b><br/> diff --git a/offapi/com/sun/star/sdb/DefinitionContent.idl b/offapi/com/sun/star/sdb/DefinitionContent.idl index d51333bbb201..263628ec7095 100644 --- a/offapi/com/sun/star/sdb/DefinitionContent.idl +++ b/offapi/com/sun/star/sdb/DefinitionContent.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module sdb { /** defines the basic functionality for an object in the hierarchy of sub documents - of a <type>OfficeDatabaseDocument</type>. + of a OfficeDatabaseDocument. @see DocumentDefinition @see DocumentContainer diff --git a/offapi/com/sun/star/sdb/DocumentDefinition.idl b/offapi/com/sun/star/sdb/DocumentDefinition.idl index 26d226fb0d17..c4f7ca780109 100644 --- a/offapi/com/sun/star/sdb/DocumentDefinition.idl +++ b/offapi/com/sun/star/sdb/DocumentDefinition.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module sdb { interface XSubDocument; -/** specifies a sub document of a <type>OfficeDatabaseDocument</type>. +/** specifies a sub document of a OfficeDatabaseDocument. <p>Usual instances of a <code>DocumentDefinition</code> are forms and reports.</p> diff --git a/offapi/com/sun/star/sdb/ErrorCondition.idl b/offapi/com/sun/star/sdb/ErrorCondition.idl index 2b8c2796f163..b0e175a7f0d1 100644 --- a/offapi/com/sun/star/sdb/ErrorCondition.idl +++ b/offapi/com/sun/star/sdb/ErrorCondition.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module sdb { wherever possible.<br/> That is, if an <code>SQLException</code> is raised by such a component, caused by an error condition which is included in the - <type>ErrorCondition</type> group, then the respective <em>negative</em> value + ErrorCondition group, then the respective <em>negative</em> value will be used as <code>ErrorCode</code>.</p> <p>This allows to determine specific error conditions in your client code, and @@ -60,10 +60,10 @@ constants ErrorCondition { // = section ROW_SET - css.sdb.RowSet related error conditions - /** is used by and <type>RowSet</type> to indicate that an operation has been vetoed + /** is used by and RowSet to indicate that an operation has been vetoed by one of its approval listeners - <p>This error condition results in raising a <type>RowSetVetoException</type>.</p> + <p>This error condition results in raising a RowSetVetoException.</p> @see RowSet @see XRowSetApproveBroadcaster @see XRowSetApproveListener @@ -77,7 +77,7 @@ constants ErrorCondition <p>Imagine you have a client-side query <code>SELECT * FROM table</code>, which is saved as "query1". Additionally, there is a query "query2" defined as <code>SELECT * FROM query1</code>. Now if you try to change the statement of - <type>query1</type> to <code>SELECT * FROM query2</code>, this is prohibited, because + query1 to <code>SELECT * FROM query2</code>, this is prohibited, because it would lead to a cyclic sub query. */ const long PARSER_CYCLIC_SUB_QUERIES = 200; diff --git a/offapi/com/sun/star/sdb/InteractionHandler.idl b/offapi/com/sun/star/sdb/InteractionHandler.idl index 3c69f3bfebea..32f7b21bc62d 100644 --- a/offapi/com/sun/star/sdb/InteractionHandler.idl +++ b/offapi/com/sun/star/sdb/InteractionHandler.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module sdb { Do not use this service anymore. Instead, create a generic <type scope="com::sun::star::task">InteractionHandler</type> instance, and pass it your request. It will determine, based on configuration data, which concrete interaction handler implementation to use for a specific request. In particular, requests formerly server by this service here - are by default passed to a <type>DatabaseInteractionHandler</type>. + are by default passed to a DatabaseInteractionHandler. */ published service InteractionHandler: com::sun::star::task::XInteractionHandler; diff --git a/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl b/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl index 7827abe34d16..748eff82f22a 100644 --- a/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl +++ b/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl @@ -36,9 +36,9 @@ module com { module sun { module star { module sdb { <ul> <li>forms</li> <li>reports</li> - <li>The table settings defined in <type>DataSettings</type></li> - <li>The query settings defined in <type>DataSettings</type></li> - <li>All properties of the service <type>DataSource</type></li> + <li>The table settings defined in DataSettings</li> + <li>The query settings defined in DataSettings</li> + <li>All properties of the service DataSource</li> </ul></p> @see com::sun::star::sdb::XOfficeDatabaseDocument @@ -77,7 +77,7 @@ service OfficeDatabaseDocument <li>calling <code>XLoadable::load</code></li> <li>calling <code>XStorable::storeAsURL</code></li> </ul> - The third option was added for compatibility reasons, since a <type>DatabaseDocument</type> + The third option was added for compatibility reasons, since a DatabaseDocument in earlier versions of OpenOffice.org did not support the <code>XLoadable</code> interface, so the usual way of creating a document from scratch was to create it, set properties as needed, and store it.</p> @@ -206,7 +206,7 @@ service OfficeDatabaseDocument /** implements life time control - <p>Whoever retrieves a <type>OfficeDatabaseDocument</type> should be aware of + <p>Whoever retrieves a OfficeDatabaseDocument should be aware of life time issues, since a document needs to be closed when nobody needs it anymore.</p> <p>This implies that clients of a document need to ensure that as soon as they don't diff --git a/offapi/com/sun/star/sdb/QueryDesign.idl b/offapi/com/sun/star/sdb/QueryDesign.idl index 1d57694455b5..acc7e533f7a9 100644 --- a/offapi/com/sun/star/sdb/QueryDesign.idl +++ b/offapi/com/sun/star/sdb/QueryDesign.idl @@ -70,7 +70,7 @@ module com { module sun { module star { module sdb { </li> <li><a name="data_source"></a><b>DataSourceName</b><br/> - specifies the name of the globally registered <type>DataSource</type> for which a query, view, or SQL + specifies the name of the globally registered DataSource for which a query, view, or SQL command is to be designed.<br/> The DataSourceName may be omitted if and only if a valid <a href="#active_connection">ActiveConnection</a> parameter is present.<br/> diff --git a/offapi/com/sun/star/sdb/RelationDesign.idl b/offapi/com/sun/star/sdb/RelationDesign.idl index bae01918b009..3b14141e9262 100644 --- a/offapi/com/sun/star/sdb/RelationDesign.idl +++ b/offapi/com/sun/star/sdb/RelationDesign.idl @@ -61,7 +61,7 @@ published service RelationDesign RelationDesign component into. </li> <li><b>DataSourceName</b><br> - The name of the globally registered <type>DataSource</type> to be used for initial display. It is only + The name of the globally registered DataSource to be used for initial display. It is only meaningful together with the other parameters specifying the object to display. </li> </ul> diff --git a/offapi/com/sun/star/sdb/RowSet.idl b/offapi/com/sun/star/sdb/RowSet.idl index f8e45ed74519..3c2d1794b93c 100644 --- a/offapi/com/sun/star/sdb/RowSet.idl +++ b/offapi/com/sun/star/sdb/RowSet.idl @@ -148,9 +148,9 @@ published interface XParametersSupplier; <h3>Deletions</h3> <p>Via <member scope="com::sun::star::sdbc">XResultSetUpdate::deleteRow</member>, you can delete the current row of a - <type>RowSet</type>. This deleted row then doesn't vanish immediately, but is still present, and subsequent calls to + RowSet. This deleted row then doesn't vanish immediately, but is still present, and subsequent calls to <member scope="com::sun::star::sdbc">XResultSet::rowDeleted</member> will return <TRUE/>. The deleted row "vanishes" from - the <type>RowSet</type> as soon as the cursor is moved away from it.<br/> + the RowSet as soon as the cursor is moved away from it.<br/> As a consequence, the behavior of several other methods is affected:<br/> <dl> <dt><member scope="com::sun::star::sdbc">XResultSet::getRow</member></dt> @@ -161,7 +161,7 @@ published interface XParametersSupplier; <dd>will let the deleted row vanish from the result set. As a consequence, the <member>RowCount</member> will decrease when you do such a move operation after deleting a row.<br/> A special case to note is the <code>next<code> call: When you delete row, say, - <code>15</code>, followed by <code>next</code>, then your <type>RowSet</type> afterwards + <code>15</code>, followed by <code>next</code>, then your RowSet afterwards still is on row 15, since the deleted row vanished with the move operation.</dd> <dt><member scope="com::sun::star::sdbc">XResultSet::refreshRow</member></dt> @@ -199,7 +199,7 @@ published service RowSet <p>If you want a row set to be based on a parametrized query, you will usually use the <type scope="com::sun::star::sdbc">XParameters</type> interface.<br/> However, you can also choose to let an interaction handler supply such data. For this, you may - for instance instantiate an <type>InteractionHandler</type>, which asks the user for the + for instance instantiate an InteractionHandler, which asks the user for the data, or you may write your own one, which supplies the data from somewhere else. The default implementation will only ask for parameters which aren't set before through the <type scope="com::sun::star::sdbc">XParameters</type> interface.</p> @@ -220,11 +220,11 @@ published service RowSet <p>The optional support of this interface is already implied with the support of the <type scope="com::sun::star::sdbc">ResultSet</type> service.</p> - <p>However, note that the additional support of the <type>XRowSetApproveBroadcaster</type> interface results + <p>However, note that the additional support of the XRowSetApproveBroadcaster interface results in a semantical extension: the methods <member scope="com::sun::star::sdbc">XResultSetUpdate::insertRow</member>, <member scope="com::sun::star::sdbc">XResultSetUpdate::updateRow</member> and <member scope="com::sun::star::sdbc">XResultSetUpdate::deleteRow</member> - will now throw the <type>RowSetVetoException</type> if the action which is to be performed was vetoed - by one of the <type>XRowSetApproveListener</type>'s.</p> + will now throw the RowSetVetoException if the action which is to be performed was vetoed + by one of the XRowSetApproveListener's.</p> */ [optional] interface com::sun::star::sdbc::XResultSetUpdate; @@ -232,10 +232,10 @@ published service RowSet <p>The optional support of this interface is already implied with the support of the <type scope="com::sun::star::sdbcx">ResultSet</type> service.</p> - <p>However, note that the additional support of the <type>XRowSetApproveBroadcaster</type> interface results + <p>However, note that the additional support of the XRowSetApproveBroadcaster interface results in a semantical extension: the method <member scope="com::sun::star::sdbcx">XDeleteRows::deleteRows</member> - will now throw the <type>RowSetVetoException</type> if the deletion was vetoed - by one of the <type>XRowSetApproveListener</type>'s.</p> + will now throw the RowSetVetoException if the deletion was vetoed + by one of the XRowSetApproveListener's.</p> */ [optional] interface com::sun::star::sdbcx::XDeleteRows; diff --git a/offapi/com/sun/star/sdb/SingleSelectQueryAnalyzer.idl b/offapi/com/sun/star/sdb/SingleSelectQueryAnalyzer.idl index 9a085f843f87..3cbd15b9c4b6 100644 --- a/offapi/com/sun/star/sdb/SingleSelectQueryAnalyzer.idl +++ b/offapi/com/sun/star/sdb/SingleSelectQueryAnalyzer.idl @@ -52,10 +52,10 @@ service SingleSelectQueryAnalyzer <p>Note that OpenOffice.org since version 2.0.4 also supports queries which are based on other queries. For example, given that you have a database containing a query named <code>All Orders</code>, the SQL statement <code>SELECT * FROM "All Orders"</code> - is perfectly valid when used with a <type>SingleSelectQueryAnalyzer</type>.</p> + is perfectly valid when used with a SingleSelectQueryAnalyzer.</p> <p>In this case, the name container returned by <member scope="com::sun::star::sdbcx">XTablesSupplier::getTables</member> - will in fact not return a <type>Table</type>, but a <type>Query</type> object. Semantically, however, + will in fact not return a Table, but a Query object. Semantically, however, this object still acts as a table in the SQL statement.</p> @see XSingleSelectQueryAnalyzer::getQueryWithSubstitution diff --git a/offapi/com/sun/star/sdb/SingleSelectQueryComposer.idl b/offapi/com/sun/star/sdb/SingleSelectQueryComposer.idl index 26c29b2231bb..a158f0fa5380 100644 --- a/offapi/com/sun/star/sdb/SingleSelectQueryComposer.idl +++ b/offapi/com/sun/star/sdb/SingleSelectQueryComposer.idl @@ -33,7 +33,7 @@ interface XSingleSelectQueryComposer; criteria. To get the new extended statement use the methods from <type scope="com::sun::star::sdb">SingleSelectQueryAnalyzer</type>. </p> - <p>A <type>SingleSelectQueryComposer</type> is usually obtained from a <type>Connection</type> + <p>A SingleSelectQueryComposer is usually obtained from a Connection using the <type scope="com::sun::star::lang">XMultiServiceFactory</type> interface.</p> */ service SingleSelectQueryComposer diff --git a/offapi/com/sun/star/sdb/TableDesign.idl b/offapi/com/sun/star/sdb/TableDesign.idl index 08d5b8500cf0..3c615ad65191 100644 --- a/offapi/com/sun/star/sdb/TableDesign.idl +++ b/offapi/com/sun/star/sdb/TableDesign.idl @@ -61,7 +61,7 @@ published service TableDesign TableDesign component into. </li> <li><b>DataSourceName</b><br> - The name of the globally registered <type>DataSource</type> to be used for initial display. It is only + The name of the globally registered DataSource to be used for initial display. It is only meaningful together with the other parameters specifying the object to display. </li> <li><b>CurrentTable</b><br> diff --git a/offapi/com/sun/star/sdb/XDataAccessDescriptorFactory.idl b/offapi/com/sun/star/sdb/XDataAccessDescriptorFactory.idl index 227294e50323..8c43f8fb0701 100644 --- a/offapi/com/sun/star/sdb/XDataAccessDescriptorFactory.idl +++ b/offapi/com/sun/star/sdb/XDataAccessDescriptorFactory.idl @@ -36,7 +36,7 @@ module com { module sun { module star { module sdb { */ interface XDataAccessDescriptorFactory { - /** creates a <type>DataAccessDescriptor</type> which supports all properties + /** creates a DataAccessDescriptor which supports all properties defined for this service, even if they're normally optional only. */ ::com::sun::star::beans::XPropertySet diff --git a/offapi/com/sun/star/sdb/XDocumentDataSource.idl b/offapi/com/sun/star/sdb/XDocumentDataSource.idl index 2d63888eb982..59e055938263 100644 --- a/offapi/com/sun/star/sdb/XDocumentDataSource.idl +++ b/offapi/com/sun/star/sdb/XDocumentDataSource.idl @@ -33,10 +33,10 @@ */ interface XDocumentDataSource { - /** provides access to the one and only <type>OfficeDatabaseDocument</type> + /** provides access to the one and only OfficeDatabaseDocument which the data source is based on. - <p>The component returned by this attribute is an <type>OfficeDatabaseDocument</type>.</p> + <p>The component returned by this attribute is an OfficeDatabaseDocument.</p> <p>Though there is a 1-to-1 relationship between database documents and data sources, each of the two can exist without its counterpart, but create this counterpart on request diff --git a/offapi/com/sun/star/sdb/XOfficeDatabaseDocument.idl b/offapi/com/sun/star/sdb/XOfficeDatabaseDocument.idl index 277b265daa00..3f94aeaedaaf 100644 --- a/offapi/com/sun/star/sdb/XOfficeDatabaseDocument.idl +++ b/offapi/com/sun/star/sdb/XOfficeDatabaseDocument.idl @@ -45,7 +45,7 @@ interface XOfficeDatabaseDocument */ interface com::sun::star::document::XDocumentSubStorageSupplier; - /** provides access to the one and only <type>DataSource</type> + /** provides access to the one and only DataSource associated with this document */ [readonly, attribute] com::sun::star::sdbc::XDataSource DataSource; diff --git a/offapi/com/sun/star/sdb/XQueriesSupplier.idl b/offapi/com/sun/star/sdb/XQueriesSupplier.idl index 8d789f236d83..509a5e9240ec 100644 --- a/offapi/com/sun/star/sdb/XQueriesSupplier.idl +++ b/offapi/com/sun/star/sdb/XQueriesSupplier.idl @@ -33,10 +33,10 @@ published interface XQueriesSupplier: com::sun::star::uno::XInterface /** returns the container of queries. - <p>The single elements of the container support the <type>Query</type> service.</p> + <p>The single elements of the container support the Query service.</p> @return - the queries belonging to database connection at which the <type>XQueriesSupplier</type> interface + the queries belonging to database connection at which the XQueriesSupplier interface is exposed. */ com::sun::star::container::XNameAccess getQueries(); diff --git a/offapi/com/sun/star/sdb/XRowSetChangeListener.idl b/offapi/com/sun/star/sdb/XRowSetChangeListener.idl index 37e04c5cf69e..24b076087070 100644 --- a/offapi/com/sun/star/sdb/XRowSetChangeListener.idl +++ b/offapi/com/sun/star/sdb/XRowSetChangeListener.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module sdb { /** is implemented by components which want to be notified when the <code>RowSet</code> supplied - by a <type>XRowSetSupplier</type> changes. + by a XRowSetSupplier changes. @see XRowSetChangeBroadcaster @see XRowSetSupplier @@ -35,7 +35,7 @@ module com { module sun { module star { module sdb { */ interface XRowSetChangeListener : ::com::sun::star::lang::XEventListener { - /** notifies the listener that the <code>RowSet</code> associated with a <type>XRowSetSupplier</type> + /** notifies the listener that the <code>RowSet</code> associated with a XRowSetSupplier has changed. */ void onRowSetChanged( [in] ::com::sun::star::lang::EventObject i_Event ); diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl index 9e6f0cab8b38..8bd9efc5cb0e 100644 --- a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl +++ b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl @@ -153,7 +153,7 @@ interface XSingleSelectQueryAnalyzer : com::sun::star::uno::XInterface /** returns the query previously set at the analyzer, with all application-level features being substituted by their database-level counterparts. - <p>The <type>XSingleSelectQueryAnalyzer</type> is an application-level component, + <p>The XSingleSelectQueryAnalyzer is an application-level component, which in some respect understands SQL features usually not present at the database level. As a prominent example, you might pass a <code>SELECT</code> statement to the analyzer which is based on another query.</p> @@ -166,7 +166,7 @@ interface XSingleSelectQueryAnalyzer : com::sun::star::uno::XInterface <p>For example, consider a database document which contains a client-side query named <code>All Orders</code>. This query is not known to the underlying database, so an SQL statement like <code>SELECT * from "All Orders"</code> would be rejected by the database. However, instantiating - a <type>SingleSelectQueryAnalyzer</type> at the <type>Connection</type> object, and passing it the above query, + a SingleSelectQueryAnalyzer at the Connection object, and passing it the above query, you can then use <code>getQueryWithSubstitution</code> to retrieve a statement where <code>"All Orders"</code> has been replaced with the <code>SELECT</code> statement which actually constitutes the <code>"All Orders"</code> query.</p> diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl index 0846fdd28734..e47ddf6f4b41 100644 --- a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl +++ b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl @@ -206,11 +206,11 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer clauses.</p> <p>There are various use cases for this. For instance, you might want to use the - statement represented by a <type>QueryDefinition</type>, and extend it with additional + statement represented by a QueryDefinition, and extend it with additional filters or sort orders, while not touching the respective parts already present in <member>QueryDefinition::Command</member>. This can be achieved by setting the <member>QueryDefinition::Command</member> as <member>ElementaryQuery</member> of a - <type>SingleSelectQueryComposer</type>.</p> + SingleSelectQueryComposer.</p> <p>If, in such a scenario, you would be interested in the filter part of the <member>QueryDefinition::Command</member>, you would set it via @@ -220,7 +220,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer <p>If you'd be interested in the composed filter, you would set the <member>QueryDefinition::Command</member> as <member>ElementaryQuery</member>, add your filter, and propagate the resulting query (<member>XSingleSelectQueryAnalyzer::getQuery</member>) - to an <type>SingleSelectQueryAnalyzer</type> instance via + to an SingleSelectQueryAnalyzer instance via <member>XSingleSelectQueryAnalyzer::setQuery</member>.</p> */ [attribute] string ElementaryQuery diff --git a/offapi/com/sun/star/sdb/XSubDocument.idl b/offapi/com/sun/star/sdb/XSubDocument.idl index 5122c04229a5..8cfc92171b06 100644 --- a/offapi/com/sun/star/sdb/XSubDocument.idl +++ b/offapi/com/sun/star/sdb/XSubDocument.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module sdb { -/** allows operating on a sub document of an <type>OfficeDatabaseDocument</type> +/** allows operating on a sub document of an OfficeDatabaseDocument @since OOo 3.1 */ diff --git a/offapi/com/sun/star/sdb/application/CopyTableContinuation.idl b/offapi/com/sun/star/sdb/application/CopyTableContinuation.idl index d688fa2ad38d..dfc3423c070e 100644 --- a/offapi/com/sun/star/sdb/application/CopyTableContinuation.idl +++ b/offapi/com/sun/star/sdb/application/CopyTableContinuation.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module sdb { module application { /** specifies the possible continuations when copying a table row via a - <type>CopyTableWizard</type> failed. + CopyTableWizard failed. */ constants CopyTableContinuation { @@ -33,7 +33,7 @@ constants CopyTableContinuation */ const short Proceed = 0; - /** is used to indicate the next registered <type>XCopyTableListener</type> should be + /** is used to indicate the next registered XCopyTableListener should be called. */ const short CallNextHandler = 1; diff --git a/offapi/com/sun/star/sdb/application/CopyTableOperation.idl b/offapi/com/sun/star/sdb/application/CopyTableOperation.idl index 3579fa933466..0a5587439519 100644 --- a/offapi/com/sun/star/sdb/application/CopyTableOperation.idl +++ b/offapi/com/sun/star/sdb/application/CopyTableOperation.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module sdb { module application { -/** specifies the different basic operations a <type>CopyTableWizard</type> +/** specifies the different basic operations a CopyTableWizard can do. @since OOo 2.4 diff --git a/offapi/com/sun/star/sdb/application/CopyTableRowEvent.idl b/offapi/com/sun/star/sdb/application/CopyTableRowEvent.idl index 5c1c40005b8e..a6529557d3a3 100644 --- a/offapi/com/sun/star/sdb/application/CopyTableRowEvent.idl +++ b/offapi/com/sun/star/sdb/application/CopyTableRowEvent.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module sdb { module application { /** specifies an event happening while copying table data between databases. - <p>Whenever this event is fired to an <type>XCopyTableListener</type>, + <p>Whenever this event is fired to an XCopyTableListener, <member scope="com::sun::star::lang">EventObject::Source</member> contains the wizard instance which actually does the copying.</p> diff --git a/offapi/com/sun/star/sdb/application/DefaultViewController.idl b/offapi/com/sun/star/sdb/application/DefaultViewController.idl index 289c9b2b08d0..46a30b39de6f 100644 --- a/offapi/com/sun/star/sdb/application/DefaultViewController.idl +++ b/offapi/com/sun/star/sdb/application/DefaultViewController.idl @@ -54,7 +54,7 @@ service DefaultViewController in other places cannot be intercepted.</p> <p>For the aforementioned tree view, the selection supplied by the <code>ContextMenuEvent::Selection</code> - component is an array of <type>NamedDatabaseObject</type> instances.</p> + component is an array of NamedDatabaseObject instances.</p> */ interface ::com::sun::star::ui::XContextMenuInterception; @@ -66,7 +66,7 @@ service DefaultViewController provides access to the current selection inside the application window, and allows to change it programmatically - <p>The selection is an array of <type>NamedDatabaseObject</type> instances.</p> + <p>The selection is an array of NamedDatabaseObject instances.</p> */ interface ::com::sun::star::view::XSelectionSupplier; diff --git a/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl b/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl index 57ed158a434d..8087ed519c2e 100644 --- a/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl +++ b/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl @@ -32,7 +32,7 @@ struct NamedDatabaseObject { /** denotes the type of the object. - <p>This member is one of the <type>DatabaseObject</type> or <type>DatabaseObjectContainer</type> constants.</p> + <p>This member is one of the DatabaseObject or DatabaseObjectContainer constants.</p> */ long Type; diff --git a/offapi/com/sun/star/sdb/application/XCopyTableListener.idl b/offapi/com/sun/star/sdb/application/XCopyTableListener.idl index d6276bb9d792..c762b463aa88 100644 --- a/offapi/com/sun/star/sdb/application/XCopyTableListener.idl +++ b/offapi/com/sun/star/sdb/application/XCopyTableListener.idl @@ -69,7 +69,7 @@ interface XCopyTableListener : ::com::sun::star::lang::XEventListener happened. @return - how to continue with copying. Must be one of the <type>CopyTableContinuation</type> + how to continue with copying. Must be one of the CopyTableContinuation constants. */ short copyRowError( [in] CopyTableRowEvent Event ); diff --git a/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl b/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl index 1ff10ddf1ee6..c5b462ec9605 100644 --- a/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl +++ b/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl @@ -47,7 +47,7 @@ interface XCopyTableWizard : ::com::sun::star::ui::dialogs::XExecutableDialog { /** specifies the basic operation for the wizard to execute. - <p>This must be one of the <type>CopyTableOperation</type> constants.</p> + <p>This must be one of the CopyTableOperation constants.</p> <p>At initialization time, you can use this attribute to control the initial operation in the wizard.</p> diff --git a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl index 67ee447a24c3..be5507584cba 100644 --- a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl +++ b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl @@ -115,7 +115,7 @@ interface XDatabaseDocumentUI @return a record describing the sub component. The first element of the returned pair is the type - of the component, denoted by one of the <type>DatabaseObject</type> constants. The second + of the component, denoted by one of the DatabaseObject constants. The second element is the name of the component. For object types which support nested structures (forms and reports, actually), this might be a hierarchical name. If the sub component has been newly created, and not yet saved, this name is empty. @@ -173,7 +173,7 @@ interface XDatabaseDocumentUI @see connect @param ObjectType - specifies the type of the object, must be one of the <type>DatabaseObject</type> + specifies the type of the object, must be one of the DatabaseObject constants. @param ObjectName @@ -266,7 +266,7 @@ interface XDatabaseDocumentUI /** creates a new sub component of the given type @param ObjectType - specifies the type of the object, must be one of the <type>DatabaseObject</type> + specifies the type of the object, must be one of the DatabaseObject constants. @param DocumentDefinition @@ -290,7 +290,7 @@ interface XDatabaseDocumentUI services.</p> @param ObjectType - specifies the type of the object, must be one of the <type>DatabaseObject</type> + specifies the type of the object, must be one of the DatabaseObject constants. @param DocumentDefinition diff --git a/offapi/com/sun/star/sdb/tools/XConnectionTools.idl b/offapi/com/sun/star/sdb/tools/XConnectionTools.idl index 0aaea1bb7bf2..8561c794a8ef 100644 --- a/offapi/com/sun/star/sdb/tools/XConnectionTools.idl +++ b/offapi/com/sun/star/sdb/tools/XConnectionTools.idl @@ -45,7 +45,7 @@ interface XDataSourceMetaData; <p>Most of the functionality provided here is meaningful only relative to a given database connection. For instance, for quoting table names, you need the meta data instance of the connection. Thus, the entry point for obtaining - a <type>XConnectionTools</type> instance is the + a XConnectionTools instance is the <type scope="com::sun::star::sdb">Connection</type> service.</p> <p>Note that nearly all functionality provided by this interface is also @@ -55,14 +55,14 @@ interface XDataSourceMetaData; */ interface XConnectionTools { - /** creates an instance supporting the <type>XTableName</type> interface, + /** creates an instance supporting the XTableName interface, which can be used to manipulate table names for various purposes. <p>The returned object is guaranteed to not be <NULL/>.</p> */ XTableName createTableName(); - /** returns an instance supporting the <type>XObjectNames</type> interface, + /** returns an instance supporting the XObjectNames interface, which provides access to functionality around table and query names. <p>The returned object is guaranteed to not be <NULL/>.</p> diff --git a/offapi/com/sun/star/sdb/tools/XTableName.idl b/offapi/com/sun/star/sdb/tools/XTableName.idl index a45ac32fa662..642a7ae13548 100644 --- a/offapi/com/sun/star/sdb/tools/XTableName.idl +++ b/offapi/com/sun/star/sdb/tools/XTableName.idl @@ -37,7 +37,7 @@ module com { module sun { module star { module sdb { module tools { Additionally, you have to respect the client-side settings which tell OpenOffice.org to use or not use catalogs and schemas in <code>SELECT</code> at all.</p> - <p>The <type>XTableName</type> interface eases this and other, similar tasks around table + <p>The XTableName interface eases this and other, similar tasks around table names.</p> <p>The component itself does not have life-time control mechanisms, i.e. you @@ -80,7 +80,7 @@ interface XTableName @see CompositionType @throws com::sun::star::IllegalArgumentException - if the given <arg>Type</arg> does not denote a valid <type>CompositionType</type> + if the given <arg>Type</arg> does not denote a valid CompositionType */ string getComposedName( [in] long Type, [in] boolean Quote ) raises ( com::sun::star::lang::IllegalArgumentException ); |