diff options
author | Michael Stahl <mstahl@redhat.com> | 2013-04-30 22:38:04 +0200 |
---|---|---|
committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:01:08 +0200 |
commit | ed993aafc928717ead4fae6b6dac8845771d8661 (patch) | |
tree | f6709f547eb3fb9ec9bc28ba9e588012161b9906 | |
parent | ccc4a67c43d5eef31c95fce445dc55ec7ebad393 (diff) |
*api: doxygen complains about lonely "." being list marker
Change-Id: Icaed7afe8f2463ffc16421642ff2e073fb4b7cc1
44 files changed, 132 insertions, 284 deletions
diff --git a/offapi/com/sun/star/configuration/backend/DataImporter.idl b/offapi/com/sun/star/configuration/backend/DataImporter.idl index 8798f7879e03..3a1b0aaf3d49 100644 --- a/offapi/com/sun/star/configuration/backend/DataImporter.idl +++ b/offapi/com/sun/star/configuration/backend/DataImporter.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module configuration { module backend { /** - allows importing data from one configuration repository into another. . + allows importing data from one configuration repository into another. @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl index d8387a969509..47fffd15c597 100644 --- a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl @@ -337,7 +337,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface /** receives notification that the value of the current property - is overridden. . + is overridden. @param aValue specifies the new value of the property. diff --git a/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl b/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl index 3b6651535e04..30148be9b25b 100644 --- a/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl @@ -282,7 +282,8 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface raises( MalformedDataException, com::sun::star::lang::WrappedTargetException ); - /** receives notification that modification of an existing property is started. . + /** receives notification that modification of an existing property is + started. <p> Subsequent calls describe changes to the value(s) of the property until a matching call to diff --git a/offapi/com/sun/star/deployment/XPackageManager.idl b/offapi/com/sun/star/deployment/XPackageManager.idl index 65ff863df21d..7f19a83bd46b 100644 --- a/offapi/com/sun/star/deployment/XPackageManager.idl +++ b/offapi/com/sun/star/deployment/XPackageManager.idl @@ -75,7 +75,7 @@ interface XPackageManager interface com::sun::star::util::XModifyBroadcaster; /** returns the underlying deployment context, that is, - the name of the repository.. + the name of the repository. @return underlying deployment context diff --git a/offapi/com/sun/star/frame/XDesktopTask.idl b/offapi/com/sun/star/frame/XDesktopTask.idl index 9e340d687ab7..bdb6a937b28f 100644 --- a/offapi/com/sun/star/frame/XDesktopTask.idl +++ b/offapi/com/sun/star/frame/XDesktopTask.idl @@ -31,7 +31,8 @@ */ published interface XDesktopTask: com::sun::star::lang::XComponent { - /** use com::sun::star::lang::XInitialization instead.. + /** use com::sun::star::lang::XInitialization instead. + @deprecated */ void initialize( [in] com::sun::star::awt::XWindow TaskWindow ); diff --git a/offapi/com/sun/star/rendering/XTextLayout.idl b/offapi/com/sun/star/rendering/XTextLayout.idl index d803c0eca78d..8d0b0ba830e2 100644 --- a/offapi/com/sun/star/rendering/XTextLayout.idl +++ b/offapi/com/sun/star/rendering/XTextLayout.idl @@ -364,7 +364,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface byte getMainTextDirection(); - /** Request the associated font for this layout.. + /** Request the associated font for this layout. @returns the associated font for this layout. */ diff --git a/offapi/com/sun/star/sdb/CallableStatement.idl b/offapi/com/sun/star/sdb/CallableStatement.idl index 6db7f0f669d0..1769b61c3874 100644 --- a/offapi/com/sun/star/sdb/CallableStatement.idl +++ b/offapi/com/sun/star/sdb/CallableStatement.idl @@ -28,8 +28,7 @@ /** represents a procedure call. The service differs only in the access of the columns and parameters to the service - com::sun::star::sdbc::CallableStatement - . + com::sun::star::sdbc::CallableStatement. */ published service CallableStatement { diff --git a/offapi/com/sun/star/sdb/ColumnSettings.idl b/offapi/com/sun/star/sdb/ColumnSettings.idl index d1c5421787cd..38d60e5c2ae7 100644 --- a/offapi/com/sun/star/sdb/ColumnSettings.idl +++ b/offapi/com/sun/star/sdb/ColumnSettings.idl @@ -93,24 +93,18 @@ published service ColumnSettings /** indicates a control model which defines the settings for layouting. - The default is - `NULL` - . + The default is `NULL`. */ [optional, property] com::sun::star::beans::XPropertySet ControlModel; /** describes an optional help text which can be used by UI components when representing this column. - The default is - `NULL` - . + The default is `NULL`. */ [optional, property] string HelpText; /** describes the default value which should be displayed by a control when moving to a new row. - The default is - `NULL` - . + The default is `NULL`. */ [optional, property] string ControlDefault; }; diff --git a/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl b/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl index af0a657f17f7..a5af742fa75e 100644 --- a/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl +++ b/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl @@ -38,9 +38,7 @@ Objects for data definition are supplied as well, for instance, Tables, Views, etc. <p> - Implements the service - com::sun::star::sdbc::Connection - . + Implements the service com::sun::star::sdbc::Connection. It is possible to open more than one connection at the same time, but the method com::sun::star::sdb::DatabaseAccessConnection::dispose() will close only one of these connections. You have to close all connections in order diff --git a/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl b/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl index 58481e7ac7c0..c4e105be6244 100644 --- a/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl +++ b/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl @@ -61,9 +61,7 @@ published service DatasourceAdministrationDialog /** allows initializing the dialog <p> You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments - method of your - com::sun::star::lang::XMultiServiceFactory - . + method of your com::sun::star::lang::XMultiServiceFactory. </p> <p> @@ -89,8 +87,7 @@ published service DatasourceAdministrationDialog <li><b>InitialSelection</b><br/> String or XDataSource describing which data source should be selected initially. This String name must be known to the - com::sun::star::sdb::DatabaseContext - . + com::sun::star::sdb::DatabaseContext. </li> </ul> </p> diff --git a/offapi/com/sun/star/sdb/ErrorMessageDialog.idl b/offapi/com/sun/star/sdb/ErrorMessageDialog.idl index 2b24067c0f29..7211d45afa17 100644 --- a/offapi/com/sun/star/sdb/ErrorMessageDialog.idl +++ b/offapi/com/sun/star/sdb/ErrorMessageDialog.idl @@ -51,9 +51,7 @@ published service ErrorMessageDialog : com::sun::star::ui::dialogs::XExecutableD /** allows initializing the dialog <p> You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments - method of your - com::sun::star::lang::XMultiServiceFactory - . + method of your com::sun::star::lang::XMultiServiceFactory. </p> <p> You specify a parameter by passing one (or more) @@ -80,8 +78,7 @@ published service ErrorMessageDialog : com::sun::star::ui::dialogs::XExecutableD com::sun::star::sdbc::SQLException describing the error which is being displayed.<br/> When initializing this value, you may use any derivative of - com::sun::star::sdbc::SQLException - . + com::sun::star::sdbc::SQLException. </li> </ul> </p> diff --git a/offapi/com/sun/star/sdb/OrderColumn.idl b/offapi/com/sun/star/sdb/OrderColumn.idl index d693fd775ec0..6d264c0313d1 100644 --- a/offapi/com/sun/star/sdb/OrderColumn.idl +++ b/offapi/com/sun/star/sdb/OrderColumn.idl @@ -31,7 +31,7 @@ service OrderColumn { service com::sun::star::sdbcx::Column; - /** describes which sort order this column has.. + /** describes which sort order this column has. The default is `TRUE`. */ [property] boolean IsAscending; diff --git a/offapi/com/sun/star/sdb/PreparedStatement.idl b/offapi/com/sun/star/sdb/PreparedStatement.idl index 7938f1d0217f..89c36d297d47 100644 --- a/offapi/com/sun/star/sdb/PreparedStatement.idl +++ b/offapi/com/sun/star/sdb/PreparedStatement.idl @@ -30,8 +30,7 @@ /** represents a precompiled SQL statement. The service differs only in the access of the columns and parameters to the service - com::sun::star::sdbc::PreparedStatement - . + com::sun::star::sdbc::PreparedStatement. */ published service PreparedStatement { diff --git a/offapi/com/sun/star/sdb/ResultColumn.idl b/offapi/com/sun/star/sdb/ResultColumn.idl index 7de15d80a37a..f3a8c2c8e75c 100644 --- a/offapi/com/sun/star/sdb/ResultColumn.idl +++ b/offapi/com/sun/star/sdb/ResultColumn.idl @@ -53,7 +53,7 @@ published service ResultColumn [readonly, property] boolean IsCaseSensitive; - /** indicates the column's normal max width in chars.. + /** indicates the column's normal max width in chars. */ [readonly, property] long DisplaySize; diff --git a/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl b/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl index e11d554547e0..67332fcb1534 100644 --- a/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl +++ b/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl @@ -24,9 +24,7 @@ module com { module sun { module star { module sdb { -/** is a factory for instances of service - com::sun::star::sdb::SQLQueryComposer - . +/** is a factory for instances of service com::sun::star::sdb::SQLQueryComposer. */ published interface XSQLQueryComposerFactory: com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/sdbc/BestRowScope.idl b/offapi/com/sun/star/sdbc/BestRowScope.idl index 2f19b6446710..da8d66a9b311 100644 --- a/offapi/com/sun/star/sdbc/BestRowScope.idl +++ b/offapi/com/sun/star/sdbc/BestRowScope.idl @@ -32,11 +32,8 @@ published constants BestRowScope A possible value for the column <code>SCOPE</code> in the - com::sun::star::sdbc::XResultSet - object - returned by the method - XDatabaseMetaData::getBestRowIdentifier() - . + com::sun::star::sdbc::XResultSet object returned by the method + XDatabaseMetaData::getBestRowIdentifier(). */ const long TEMPORARY = 0; @@ -45,11 +42,8 @@ published constants BestRowScope A possible value for the column <code>SCOPE</code> in the - com::sun::star::sdbc::XResultSet - object - returned by the method - XDatabaseMetaData::getBestRowIdentifier() - . + com::sun::star::sdbc::XResultSet object returned by the method + XDatabaseMetaData::getBestRowIdentifier(). */ const long TRANSACTION = 1; @@ -58,11 +52,8 @@ published constants BestRowScope A possible value for the column <code>SCOPE</code> in the - com::sun::star::sdbc::XResultSet - object - returned by the method - XDatabaseMetaData::getBestRowIdentifier() - . + com::sun::star::sdbc::XResultSet object returned by the method + XDatabaseMetaData::getBestRowIdentifier(). */ const long SESSION = 2; }; diff --git a/offapi/com/sun/star/sdbc/BestRowType.idl b/offapi/com/sun/star/sdbc/BestRowType.idl index eba306904586..df95e3fb43dd 100644 --- a/offapi/com/sun/star/sdbc/BestRowType.idl +++ b/offapi/com/sun/star/sdbc/BestRowType.idl @@ -31,11 +31,8 @@ published constants BestRowType A possible value for the column <code>PSEUDO_COLUMN</code> in the - com::sun::star::sdbc::XResultSet - object - returned by the method - XDatabaseMetaData::getBestRowIdentifier() - . + com::sun::star::sdbc::XResultSet object returned by the method + XDatabaseMetaData::getBestRowIdentifier(). */ const long UNKNOWN = 0; @@ -43,11 +40,8 @@ published constants BestRowType A possible value for the column <code>PSEUDO_COLUMN</code> in the - com::sun::star::sdbc::XResultSet - object - returned by the method - XDatabaseMetaData::getBestRowIdentifier() - . + com::sun::star::sdbc::XResultSet object returned by the method + XDatabaseMetaData::getBestRowIdentifier(). */ const long NOT_PSEUDO = 1; @@ -55,11 +49,8 @@ published constants BestRowType A possible value for the column <code>PSEUDO_COLUMN</code> in the - com::sun::star::sdbc::XResultSet - object - returned by the method - XDatabaseMetaData::getBestRowIdentifier() - . + com::sun::star::sdbc::XResultSet object returned by the method + XDatabaseMetaData::getBestRowIdentifier(). */ const long PSEUDO = 2; }; diff --git a/offapi/com/sun/star/sdbc/CallableStatement.idl b/offapi/com/sun/star/sdbc/CallableStatement.idl index 15ece85f5899..b61cd0c48411 100644 --- a/offapi/com/sun/star/sdbc/CallableStatement.idl +++ b/offapi/com/sun/star/sdbc/CallableStatement.idl @@ -48,11 +48,7 @@ . The type of all OUT parameters must be registered prior to executing the stored procedure; their values are retrieved after execution via the - <code>get</code> - methods - provided by the - com::sun::star::sdbc::XRow - . + <code>get</code> methods provided by the com::sun::star::sdbc::XRow. </p> <p> A @@ -63,10 +59,8 @@ com::sun::star::sdbc::ResultSet objects. Multiple <code>ResultSet</code> - objects are - handled using operations inherited from - com::sun::star::sdbc::XPreparedStatement - . + objects are handled using operations inherited from + com::sun::star::sdbc::XPreparedStatement. </p> <p> For maximum portability, a call's diff --git a/offapi/com/sun/star/sdbc/ColumnSearch.idl b/offapi/com/sun/star/sdbc/ColumnSearch.idl index 27fd9772d559..200179475d8a 100644 --- a/offapi/com/sun/star/sdbc/ColumnSearch.idl +++ b/offapi/com/sun/star/sdbc/ColumnSearch.idl @@ -30,8 +30,7 @@ published constants ColumnSearch /** A possible value for column <code>SEARCHABLE</code> in the com::sun::star::sdbc::XResultSet object returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getTypeInfo() - . + com::sun::star::sdbc::XDatabaseMetaData::getTypeInfo(). <p> Indicates that <code>WHERE</code> @@ -43,23 +42,20 @@ published constants ColumnSearch /** A possible value for column <code>SEARCHABLE</code> in the com::sun::star::sdbc::XResultSet object returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getTypeInfo() - . + com::sun::star::sdbc::XDatabaseMetaData::getTypeInfo(). <p> Indicates that the only <code>WHERE</code> search clause that can be based on this type is - <code>WHERE...LIKE</code> - . + <code>WHERE...LIKE</code>. */ const long CHAR = 1; /** A possible value for column <code>SEARCHABLE</code> in the com::sun::star::sdbc::XResultSet object returned by the method - com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo() - . + com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo(). <p> Indicates that one can base all <code>WHERE</code> @@ -75,8 +71,7 @@ published constants ColumnSearch in the com::sun::star::sdbc::XResultSet object returned by the method - com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo() - . + com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo(). <p> Indicates that all <code>WHERE</code> diff --git a/offapi/com/sun/star/sdbc/ColumnType.idl b/offapi/com/sun/star/sdbc/ColumnType.idl index 7dfd8dc6b419..026d24a72d72 100644 --- a/offapi/com/sun/star/sdbc/ColumnType.idl +++ b/offapi/com/sun/star/sdbc/ColumnType.idl @@ -31,11 +31,8 @@ published constants ColumnType A possible value for the column <code>PSEUDO_COLUMN</code> in the - com::sun::star::sdbc::XResultSet - object - returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getVersionColumns() - . + com::sun::star::sdbc::XResultSet object returned by the method + com::sun::star::sdbc::XDatabaseMetaData::getVersionColumns(). */ const long UNKNOWN = 0; @@ -43,11 +40,8 @@ published constants ColumnType A possible value for the column <code>PSEUDO_COLUMN</code> in the - com::sun::star::sdbc::XResultSet - object - returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getVersionColumns() - . + com::sun::star::sdbc::XResultSet object returned by the method + com::sun::star::sdbc::XDatabaseMetaData::getVersionColumns(). */ const long NOT_PSEUDO = 1; @@ -55,11 +49,8 @@ published constants ColumnType A possible value for the column <code>PSEUDO_COLUMN</code> in the - com::sun::star::sdbc::XResultSet - object - returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getVersionColumns() - . + com::sun::star::sdbc::XResultSet object returned by the method + com::sun::star::sdbc::XDatabaseMetaData::getVersionColumns(). */ const long PSEUDO = 2; }; diff --git a/offapi/com/sun/star/sdbc/DataTruncation.idl b/offapi/com/sun/star/sdbc/DataTruncation.idl index 2fd35f1c08e0..91363dd6e027 100644 --- a/offapi/com/sun/star/sdbc/DataTruncation.idl +++ b/offapi/com/sun/star/sdbc/DataTruncation.idl @@ -30,9 +30,7 @@ <p> The SQL state for a <code>DataTruncation</code> - is - <code>01004</code> - . + is <code>01004</code>. </p> */ published exception DataTruncation: SQLWarning diff --git a/offapi/com/sun/star/sdbc/DataType.idl b/offapi/com/sun/star/sdbc/DataType.idl index 5f5cc09365c8..0b442836e8c4 100644 --- a/offapi/com/sun/star/sdbc/DataType.idl +++ b/offapi/com/sun/star/sdbc/DataType.idl @@ -30,8 +30,8 @@ </p> <p> Precise information about the specific types can be got from - XDatabaseMetaData::getTypeInfo() - .</p> + XDatabaseMetaData::getTypeInfo(). + </p> */ published constants DataType { @@ -78,9 +78,7 @@ published constants DataType /** indicates that the SQL type is database-specific and gets mapped to an object that can be accessed via - the method - com::sun::star::sdbc::XRow::getObject() - . + the method com::sun::star::sdbc::XRow::getObject(). */ const long OTHER = 1111; diff --git a/offapi/com/sun/star/sdbc/IndexType.idl b/offapi/com/sun/star/sdbc/IndexType.idl index ad5a3fa9830f..d3224e997207 100644 --- a/offapi/com/sun/star/sdbc/IndexType.idl +++ b/offapi/com/sun/star/sdbc/IndexType.idl @@ -32,8 +32,7 @@ published constants IndexType in the com::sun::star::sdbc::XResultSet object returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getIndexInfo() - . + com::sun::star::sdbc::XDatabaseMetaData::getIndexInfo(). <P> Identifies table statistics that are returned in conjunction with a table's index description. @@ -46,8 +45,7 @@ published constants IndexType in the com::sun::star::sdbc::XResultSet object returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getIndexInfo() - . + com::sun::star::sdbc::XDatabaseMetaData::getIndexInfo(). <P> Indicates that this table index is a clustered index. </P> @@ -59,8 +57,7 @@ published constants IndexType in the com::sun::star::sdbc::XResultSet object returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getIndexInfo() - . + com::sun::star::sdbc::XDatabaseMetaData::getIndexInfo(). <P> Indicates that this table index is a hashed index. </P> @@ -72,8 +69,7 @@ published constants IndexType in the com::sun::star::sdbc::XResultSet object returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getIndexInfo() - . + com::sun::star::sdbc::XDatabaseMetaData::getIndexInfo(). <P> Indicates that this table index is not a clustered index, a hashed index, or table statistics; diff --git a/offapi/com/sun/star/sdbc/KeyRule.idl b/offapi/com/sun/star/sdbc/KeyRule.idl index 3e886bb5a6eb..30eae77a6559 100644 --- a/offapi/com/sun/star/sdbc/KeyRule.idl +++ b/offapi/com/sun/star/sdbc/KeyRule.idl @@ -34,13 +34,9 @@ published constants KeyRule in the com::sun::star::sdbc::XResultSet objects returned by the methods - com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys() - , - com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys() - , - and - com::sun::star::sdbc::XDatabaseMetaData::getCrossReference() - . + com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(), + com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(), + and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference(). <P> For the column <code>UPDATE_RULE</code> @@ -67,13 +63,9 @@ published constants KeyRule in the com::sun::star::sdbc::XResultSet objects returned by the methods - com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys() - , - com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys() - , - and - com::sun::star::sdbc::XDatabaseMetaData::getCrossReference() - . + com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(), + com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(), + and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference(). <P> For the column <code>UPDATE_RULE</code> @@ -98,13 +90,9 @@ published constants KeyRule in the com::sun::star::sdbc::XResultSet objects returned by the methods - com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys() - , - com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys() - , - and - com::sun::star::sdbc::XDatabaseMetaData::getCrossReference() - . + com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(), + com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(), + and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference(). <P> For the columns <code>UPDATE_RULE</code> @@ -125,13 +113,9 @@ published constants KeyRule in the com::sun::star::sdbc::XResultSet objects returned by the methods - com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys() - , - com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys() - , - and - com::sun::star::sdbc::XDatabaseMetaData::getCrossReference() - . + com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(), + com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(), + and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference(). <P> For the columns <code>UPDATE_RULE</code> @@ -150,13 +134,9 @@ published constants KeyRule in the com::sun::star::sdbc::XResultSet objects returned by the methods - com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys() - , - com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys() - , - and - com::sun::star::sdbc::XDatabaseMetaData::getCrossReference() - . + com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys(), + com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys(), + and com::sun::star::sdbc::XDatabaseMetaData::getCrossReference(). <P> For the columns <code>UPDATE_RULE</code> diff --git a/offapi/com/sun/star/sdbc/ProcedureColumn.idl b/offapi/com/sun/star/sdbc/ProcedureColumn.idl index bb9d61bcca69..2ddcedb47810 100644 --- a/offapi/com/sun/star/sdbc/ProcedureColumn.idl +++ b/offapi/com/sun/star/sdbc/ProcedureColumn.idl @@ -33,8 +33,7 @@ published constants ProcedureColumn in the com::sun::star::sdbc::XResultSet returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns() - . + com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns(). */ const long UNKNOWN = 0; @@ -44,8 +43,7 @@ published constants ProcedureColumn in the com::sun::star::sdbc::XResultSet returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns() - . + com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns(). */ const long IN = 1; @@ -55,8 +53,7 @@ published constants ProcedureColumn in the com::sun::star::sdbc::XResultSet returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns() - . + com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns(). */ const long INOUT = 2; @@ -66,8 +63,7 @@ published constants ProcedureColumn in the com::sun::star::sdbc::XResultSet returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns() - . + com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns(). */ const long RESULT = 3; @@ -77,8 +73,7 @@ published constants ProcedureColumn in the com::sun::star::sdbc::XResultSet returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns() - . + com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns(). */ const long OUT = 4; @@ -88,8 +83,7 @@ published constants ProcedureColumn in the com::sun::star::sdbc::XResultSet returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns() - . + com::sun::star::sdbc::XDatabaseMetaData::getProcedureColumns(). */ const long RETURN = 5; }; diff --git a/offapi/com/sun/star/sdbc/ProcedureResult.idl b/offapi/com/sun/star/sdbc/ProcedureResult.idl index 2df3c73980b0..bdd0ed2eed98 100644 --- a/offapi/com/sun/star/sdbc/ProcedureResult.idl +++ b/offapi/com/sun/star/sdbc/ProcedureResult.idl @@ -32,8 +32,7 @@ published constants ProcedureResult in the com::sun::star::sdbc::XResultSet object returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getProcedures() - . + com::sun::star::sdbc::XDatabaseMetaData::getProcedures(). <p> Indicates that it is not known whether the procedure returns a result. @@ -46,8 +45,7 @@ published constants ProcedureResult in the com::sun::star::sdbc::XResultSet object returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getProcedures() - . + com::sun::star::sdbc::XDatabaseMetaData::getProcedures(). <p> Indicates that the procedure does not return a result. @@ -60,8 +58,7 @@ published constants ProcedureResult in the com::sun::star::sdbc::XResultSet object returned by the method - com::sun::star::sdbc::XDatabaseMetaData::getProcedures() - . + com::sun::star::sdbc::XDatabaseMetaData::getProcedures(). <p> Indicates that the procedure returns a result. diff --git a/offapi/com/sun/star/sdbc/XArray.idl b/offapi/com/sun/star/sdbc/XArray.idl index f55faae9c13b..2a2b69b1fad8 100644 --- a/offapi/com/sun/star/sdbc/XArray.idl +++ b/offapi/com/sun/star/sdbc/XArray.idl @@ -32,16 +32,10 @@ published interface XResultSet; -/** is used for mapping the SQL type - com::sun::star::sdbc::DataType::ARRAY - . - By default, an - <code>Array</code> - is a transaction duration - reference to an SQL array. By default, an - - <code>Array</code> +/** is used for mapping the SQL type com::sun::star::sdbc::DataType::ARRAY. + By default, an <code>Array</code> is a transaction duration + reference to an SQL array. By default, an <code>Array</code> is implemented using a SQL LOCATOR(array) internally. */ published interface XArray: com::sun::star::uno::XInterface @@ -134,10 +128,8 @@ published interface XArray: com::sun::star::uno::XInterface @returns an array containing up to <code>count</code> - consecutive elements - of the SQL array, beginning with element - <code>index</code> - . + consecutive elements of the SQL array, beginning with element + <code>index</code>. @throws SQLException if an error occurs while attempting to access the array. */ diff --git a/offapi/com/sun/star/sdbc/XBlob.idl b/offapi/com/sun/star/sdbc/XBlob.idl index a05dad403396..98bdb1eedd72 100644 --- a/offapi/com/sun/star/sdbc/XBlob.idl +++ b/offapi/com/sun/star/sdbc/XBlob.idl @@ -30,11 +30,7 @@ module com { module sun { module star { module sdbc { -/** is the representation (mapping) of an SQL - <i> - BLOB - </i> - . +/** is the representation (mapping) of an SQL <i>BLOB</i>. <p> A SQL @@ -74,10 +70,7 @@ and <code>setBlob</code> allow a programmer to access the SQL - <i> - BLOB - </i> - . + <i>BLOB</i>. <br/> The <code>Blob</code> @@ -147,14 +140,9 @@ published interface XBlob: com::sun::star::uno::XInterface by this <code>Blob</code> object, starting with the byte at position - <code>pos</code> - . + <code>pos</code>. @throws SQLException - if there is an error accessing the - <i> - BLOB - </i> - . + if there is an error accessing the <i>BLOB</i>. */ sequence<byte> getBytes([in]hyper pos, [in]long length) raises (SQLException); @@ -186,9 +174,7 @@ published interface XBlob: com::sun::star::uno::XInterface object represents. The search for <code>pattern</code> - begins at position - <code>start</code> - . + begins at position <code>start</code>. @param pattern the pattern to search @returns @@ -209,9 +195,7 @@ published interface XBlob: com::sun::star::uno::XInterface <code>Blob</code> object at which <code>pattern</code> - begins. The search begins at position - <code>start</code> - . + begins. The search begins at position <code>start</code>. @param pattern the pattern to search @param start diff --git a/offapi/com/sun/star/sdbc/XClob.idl b/offapi/com/sun/star/sdbc/XClob.idl index 9f8cac3b8e76..bc0d2bc81f0c 100644 --- a/offapi/com/sun/star/sdbc/XClob.idl +++ b/offapi/com/sun/star/sdbc/XClob.idl @@ -82,10 +82,7 @@ <code>getClob</code> and <code>setClob</code> - allow a programmer to - access the SQL - <code>CLOB</code> - . + allow a programmer to access the SQL <code>CLOB</code>. </p> */ published interface XClob: com::sun::star::uno::XInterface @@ -145,10 +142,9 @@ published interface XClob: com::sun::star::uno::XInterface /** determines the character position at which the specified substring <code>searchstr</code> appears in the - <code>Clob</code> - . The search begins at position - <code>start</code> - . + <code>Clob</code>. + The search begins at position <code>start</code>. + @param searchstr the string to search @param start @@ -168,9 +164,8 @@ published interface XClob: com::sun::star::uno::XInterface <code>pattern</code> appears in this <code>Clob</code> - object. The search begins at position - <code>start</code> - . + object. + The search begins at position <code>start</code>. @param pattern the CLOB to search @param start diff --git a/offapi/com/sun/star/sdbc/XConnection.idl b/offapi/com/sun/star/sdbc/XConnection.idl index a54a39fd8876..92ddb331fdf7 100644 --- a/offapi/com/sun/star/sdbc/XConnection.idl +++ b/offapi/com/sun/star/sdbc/XConnection.idl @@ -66,8 +66,7 @@ published interface XConnection: com::sun::star::sdbc::XCloseable SQL statements without parameters are normally executed using Statement objects. If the same SQL statement is executed many times, it is more efficient to use a - com::sun::star::sdbc::PreparedStatement - . + com::sun::star::sdbc::PreparedStatement. </p> <p> Result sets created using the returned Statement will have @@ -191,8 +190,7 @@ published interface XConnection: com::sun::star::sdbc::XCloseable the method com::sun::star::sdbc::XConnection::commit() or the method - com::sun::star::sdbc::XConnection::rollback() - . + com::sun::star::sdbc::XConnection::rollback(). By default, new connections are in auto-commit mode. </p> <p> diff --git a/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl index f184b96f986d..f3772fc3884d 100644 --- a/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl +++ b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl @@ -44,8 +44,7 @@ com::sun::star::sdbc::XRow::getInt() to retrieve the data from these XResultSets. If a given form of metadata is not available, these methods should throw a - com::sun::star::sdbc::SQLException - . + com::sun::star::sdbc::SQLException. After calling one of the getXXX() methods, one can check whether that value is `NULL` with the method com::sun::star::sdbc::XRow::wasNull(). @@ -75,9 +74,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface @return `TRUE` if the user is allowed to call all procedures returned by getProcedures - otherwise - `FALSE` - . + otherwise `FALSE`. @throws SQLException if a database access error occurs. */ @@ -375,9 +372,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** `TRUE` , if the Database supports the CONVERT function between SQL types, - otherwise - `FALSE` - . + otherwise `FALSE`. @returns `TRUE` if so @throws SQLException @@ -387,9 +382,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** `TRUE` , if the Database supports the CONVERT between the given SQL types - otherwise - `FALSE` - . + otherwise `FALSE`. @returns `TRUE` if so @throws SQLException @@ -2344,9 +2337,8 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface boolean updatesAreDetected([in]long setType) raises (SQLException); /** indicates whether or not a visible row delete can be detected by - calling - com::sun::star::sdbc::XResultSet::rowDeleted() - . If deletesAreDetected() + calling com::sun::star::sdbc::XResultSet::rowDeleted(). + If deletesAreDetected() returns `FALSE`, then deleted rows are removed from the result set. @param setType defined in diff --git a/offapi/com/sun/star/sdbc/XOutParameters.idl b/offapi/com/sun/star/sdbc/XOutParameters.idl index 5678f46ad187..d378ae5e292d 100644 --- a/offapi/com/sun/star/sdbc/XOutParameters.idl +++ b/offapi/com/sun/star/sdbc/XOutParameters.idl @@ -48,7 +48,6 @@ published interface XOutParameters: com::sun::star::uno::XInterface of user-named types include: STRUCT, DISTINCT, OBJECT, and named array types. - <p> Before executing a stored procedure call, you must explicitly call @@ -91,9 +90,7 @@ published interface XOutParameters: com::sun::star::uno::XInterface /** registers the OUT parameter in ordinal position <code>parameterIndex</code> - to the SDBC type - <code>sqlType</code> - . All + to the SDBC type <code>sqlType</code>. All OUT parameters must be registered before a stored procedure is executed. @@ -108,9 +105,7 @@ published interface XOutParameters: com::sun::star::uno::XInterface should be used when the parameter is of SDBC type com::sun::star::sdbc::DataType::NUMERIC - or - com::sun::star::sdbc::DataType::DECIMAL - . + or com::sun::star::sdbc::DataType::DECIMAL. @param parameterIndex the first parameter is 1, the second is 2, ... @param sqlType diff --git a/offapi/com/sun/star/sdbc/XResultSet.idl b/offapi/com/sun/star/sdbc/XResultSet.idl index c2f9d627d9fb..d49e33757d55 100644 --- a/offapi/com/sun/star/sdbc/XResultSet.idl +++ b/offapi/com/sun/star/sdbc/XResultSet.idl @@ -31,8 +31,7 @@ /** provides the navigation on a table of data. A com::sun::star::sdbc::ResultSet object is usually generated by executing a - com::sun::star::sdbc::Statement - . + com::sun::star::sdbc::Statement. <p> @@ -126,7 +125,7 @@ published interface XResultSet: com::sun::star::uno::XInterface /** moves the cursor to the first row in the result set. @returns - `TRUE` if successful + `TRUE` if successful @throws SQLException if a database access error occurs. */ @@ -176,10 +175,7 @@ published interface XResultSet: com::sun::star::uno::XInterface <p> Note: Calling <code>absolute(1)</code> - is the same - as calling - com::sun::star::sdbc::XResultSet::first() - . + is the same as calling com::sun::star::sdbc::XResultSet::first(). Calling <code>moveToPosition(-1)</code> is the same as calling <code>moveToLast()</code>. </p> @@ -295,9 +291,7 @@ published interface XResultSet: com::sun::star::uno::XInterface com::sun::star::sdbc::ResultSet object. If the result set was generated some other way, such as by an com::sun::star::sdbc::XDatabaseMetaData - method, this method returns - `NULL` - . + method, this method returns `NULL`. @returns the statement object @throws SQLException diff --git a/offapi/com/sun/star/sdbc/XWarningsSupplier.idl b/offapi/com/sun/star/sdbc/XWarningsSupplier.idl index 92d85a698b82..9f06ff6505f9 100644 --- a/offapi/com/sun/star/sdbc/XWarningsSupplier.idl +++ b/offapi/com/sun/star/sdbc/XWarningsSupplier.idl @@ -38,8 +38,7 @@ published interface XWarningsSupplier: com::sun::star::uno::XInterface <p> <b>Note:</b> Subsequent warnings will be chained to this - com::sun::star::sdbc::SQLWarning - . + com::sun::star::sdbc::SQLWarning. </p> @returns the warnings diff --git a/offapi/com/sun/star/sdbcx/PreparedStatement.idl b/offapi/com/sun/star/sdbcx/PreparedStatement.idl index 12edbb062eed..4e5be7bc787c 100644 --- a/offapi/com/sun/star/sdbcx/PreparedStatement.idl +++ b/offapi/com/sun/star/sdbcx/PreparedStatement.idl @@ -35,9 +35,7 @@ published service PreparedStatement service com::sun::star::sdbc::PreparedStatement; /** returns if a result set should allow the navigation with bookmarks - or not. The default is - `FALSE` - . + or not. The default is `FALSE`. */ [property] boolean UseBookmarks; }; diff --git a/offapi/com/sun/star/sdbcx/Statement.idl b/offapi/com/sun/star/sdbcx/Statement.idl index 9a045f839892..47c97bb0ea4d 100644 --- a/offapi/com/sun/star/sdbcx/Statement.idl +++ b/offapi/com/sun/star/sdbcx/Statement.idl @@ -38,9 +38,7 @@ published service Statement /** returns `TRUE` if a result set should allow navigation with bookmarks or not. - The default is - `FALSE` - . + The default is `FALSE`. */ [property] boolean UseBookmarks; }; diff --git a/offapi/com/sun/star/style/PageProperties.idl b/offapi/com/sun/star/style/PageProperties.idl index 2573d6fe733b..f3a9a8302b5f 100644 --- a/offapi/com/sun/star/style/PageProperties.idl +++ b/offapi/com/sun/star/style/PageProperties.idl @@ -312,7 +312,7 @@ of the current page is used as limit. for the possible values. */ [optional,property] short FootnoteLineStyle; -/** contains the color of the separator line between the text and the footnote area.. +/** contains the color of the separator line between the text and the footnote area. */ [optional,property] com::sun::star::util::Color FootnoteLineColor; /** contains the relative width of the separator line between the text and the footnote area. diff --git a/offapi/com/sun/star/text/TextGraphicObject.idl b/offapi/com/sun/star/text/TextGraphicObject.idl index 2fc4455662ee..32c7dde0db03 100644 --- a/offapi/com/sun/star/text/TextGraphicObject.idl +++ b/offapi/com/sun/star/text/TextGraphicObject.idl @@ -112,8 +112,8 @@ published service TextGraphicObject It contains percentage values between -100 and +100. */ [property] boolean GraphicIsInverted; - /** . - It contains percentage values between -100 and +100. + + /** contains percentage values between -100 and +100. */ [property] short Transparency; /** contains the ColorMode as com::sun::star::drawing::ColorMode. diff --git a/offapi/com/sun/star/text/XParagraphAppend.idl b/offapi/com/sun/star/text/XParagraphAppend.idl index 153d345b8e06..5413a3f42ace 100644 --- a/offapi/com/sun/star/text/XParagraphAppend.idl +++ b/offapi/com/sun/star/text/XParagraphAppend.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module text { -/** . +/** allows inserting and appending paragraphs. */ interface XParagraphAppend : com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/text/XTextAppend.idl b/offapi/com/sun/star/text/XTextAppend.idl index 1ae544e1ba5a..bac545c31d77 100644 --- a/offapi/com/sun/star/text/XTextAppend.idl +++ b/offapi/com/sun/star/text/XTextAppend.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module text { -/** . +/** is a meta-interface for manipulating and inserting text. */ interface XTextAppend { diff --git a/offapi/com/sun/star/text/XTextContent.idl b/offapi/com/sun/star/text/XTextContent.idl index 8b1a541e9f08..9cb28cb8829b 100644 --- a/offapi/com/sun/star/text/XTextContent.idl +++ b/offapi/com/sun/star/text/XTextContent.idl @@ -36,18 +36,11 @@ published interface XTextContent: com::sun::star::lang::XComponent /** is called when this object gets embedded in a text. - - <p>This acts like a multi-phase construction, thus the object may be - invalid until it is attached to a text position. In general, this method - is called from within - - - - - . - + invalid until it is attached to a text position. Usually this method + is called from within XText::insertTextContent(). </p> + <p>Both text objects and text content objects may only be connected to each other if they are created by the same component. When implementing new components, this behavior is deprecated.</p> diff --git a/offapi/com/sun/star/text/XTextContentAppend.idl b/offapi/com/sun/star/text/XTextContentAppend.idl index e737ccccfd2b..d28f6d62da3b 100644 --- a/offapi/com/sun/star/text/XTextContentAppend.idl +++ b/offapi/com/sun/star/text/XTextContentAppend.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module text { -/** . +/** allows inserting and appending text content. */ interface XTextContentAppend : com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/text/XTextConvert.idl b/offapi/com/sun/star/text/XTextConvert.idl index 2ec1976abca0..b707489abcfb 100644 --- a/offapi/com/sun/star/text/XTextConvert.idl +++ b/offapi/com/sun/star/text/XTextConvert.idl @@ -34,21 +34,22 @@ module com { module sun { module star { module text { -/** . +/** allows converting selections of text to frames or tables. */ interface XTextConvert : com::sun::star::uno::XInterface { /** moves the paragraphs from Start to End into a text frame. - <p>FrameProperties contains the properties of the to-be-created text frame.</p> - @param - . + @param Start start position of frame content - @param - . - @return + @param End end position of frame content + + @param FrameProperties + contains the properties of the to-be-created text frame + + @return the newly created text frame */ ::com::sun::star::text::XTextContent convertToTextFrame( @@ -58,7 +59,7 @@ interface XTextConvert : com::sun::star::uno::XInterface raises( com::sun::star::lang::IllegalArgumentException, com::sun::star::beans::UnknownPropertyException ); - /** . + /** converts the paragraphs marked in TableRanges into a table. @param TableRanges contains the TextRange interfaces of the paragraphs, cells and rows of the table. diff --git a/offapi/com/sun/star/text/XTextPortionAppend.idl b/offapi/com/sun/star/text/XTextPortionAppend.idl index a44cf2dd40b2..b15ade7dd4e3 100644 --- a/offapi/com/sun/star/text/XTextPortionAppend.idl +++ b/offapi/com/sun/star/text/XTextPortionAppend.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module text { -/** . +/** allows inserting and appending formatted text portions. */ interface XTextPortionAppend : com::sun::star::uno::XInterface { |