[PATCH] [REVIEW:3-5,3-4] api documentation error

[Lionel Elie Mamane]

I corrected an error (bad link/reference) in the API documentation for
com::sun::star::sdbc::XDatabaseMetaData. Do we backport that kind of
things? It would suck somewhat for our on-line version to be wrong
until after the release of 3.6.

So I propose we backport this to 3.5, and maybe 3.4, too?

-- 
Lionel
From 7535373fa693ddff5311054800efcc602cdcacd9 Mon Sep 17 00:00:00 2001
From: Lionel Elie Mamane lio...@mamane.lu
Date: Tue, 14 Feb 2012 06:19:08 +0100
Subject: [PATCH] correct documentation of
 com::sun::star::sdbc::XDatabaseMetaData

---
 offapi/com/sun/star/sdbc/XDatabaseMetaData.idl |   16 +---
 1 files changed, 9 insertions(+), 7 deletions(-)

diff --git a/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl
index 4f06bb5..abee6d2 100644
--- a/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl
+++ b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl
@@ -45,17 +45,19 @@
 the form of
 type scope=com::sun::star::sdbcXResultSet/type
 objects.
-You can use the normal type scope=com::sun::star::sdbcXResultSet/type
+You can use the normal type scope=com::sun::star::sdbcXRow/type
+(or type scope=com::sun::star::sdbXColumn/type)
 methods such as
-member scope=com::sun::star::sdbcXResultSet::getString()/member
+member scope=com::sun::star::sdbcXRow::getString()/member
 and
-member scope=com::sun::star::sdbcXResultSet::getInt()/member
+member scope=com::sun::star::sdbcXRow::getInt()/member
 to retrieve the data from these XResultSets. If a given form of
 metadata is not available, these methods should throw a
 type scope=com::sun::star::sdbcSQLException/type
 .
-That a value of type scope=com::sun::star::sdbcXResultSet/type is NULL/
-can be checked with the method member scope=com::sun::star::sdbcXResultSet::wasNull()/member.
+After calling one of the getXXX() methods,
+one can check whether that value is NULL/
+with the method member scope=com::sun::star::sdbcXRow::wasNull()/member.
 In the text only (may be NULL/) is mentioned for this case.
 /p
 pSome of these methods take arguments that are String patterns. These
@@ -69,8 +71,7 @@
 A
 type scope=com::sun::star::sdbcSQLException/type
 will be thrown if a driver does not support
-a meta data method. In the case of methods that return an XResultSet,
+a metadata method. In the case of methods that return an XResultSet,
 either an XResultSet (which may be empty) is returned or a
 SQLException is thrown./p
  */
-- 
1.7.7.3

___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

[PUSHED][3-5] Re: [PATCH] [REVIEW:3-5,3-4] api documentation error

[Michael Stahl]

On 14/02/12 15:46, Lionel Elie Mamane wrote:
 I corrected an error (bad link/reference) in the API documentation for
 com::sun::star::sdbc::XDatabaseMetaData. Do we backport that kind of
 things? It would suck somewhat for our on-line version to be wrong
 until after the release of 3.6.
 
 So I propose we backport this to 3.5, and maybe 3.4, too?

pushed to libreoffice-3-5:

http://cgit.freedesktop.org/libreoffice/core/commit/?h=libreoffice-3-5id=0a28ddf2084f86743e229667ae2c9b7e4f95e49e

hmm.. am too lazy for -3-4 because probably most people read this stuff
on api.libreoffice.org and i guess that should be generated from latest
stable release.

___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice