sb118: added documentation

5 files changed, 24 insertions, 5 deletions

diff --git a/test/inc/test/getargument.hxx b/test/inc/test/getargument.hxx
index 0c109861ccfc..1b4df29d2115 100644
--- a/test/inc/test/getargument.hxx
+++ b/test/inc/test/getargument.hxx
@@ -34,6 +34,8 @@ namespace rtl { class OUString; }
 
 namespace test {
 
+// Obtain the value of an argument tunneled in via an "arg-<name>" bootstrap
+// variable:
 OOO_DLLPUBLIC_TEST bool getArgument(
     rtl::OUString const & name, rtl::OUString * value);
 
diff --git a/test/inc/test/officeconnection.hxx b/test/inc/test/officeconnection.hxx
index 60de9e784921..99a319d51a7e 100644
--- a/test/inc/test/officeconnection.hxx
+++ b/test/inc/test/officeconnection.hxx
@@ -39,6 +39,8 @@ namespace com { namespace sun { namespace star { namespace lang {
 
 namespace test {
 
+// Start up and shut down an OOo instance (details about the OOo instance are
+// tunneled in via "arg-..." bootstrap variables):
 class OOO_DLLPUBLIC_TEST OfficeConnection: private boost::noncopyable {
 public:
     OfficeConnection();
diff --git a/test/inc/test/oustringostreaminserter.hxx b/test/inc/test/oustringostreaminserter.hxx
index 9c9ef527be7c..187b0ebd5f83 100644
--- a/test/inc/test/oustringostreaminserter.hxx
+++ b/test/inc/test/oustringostreaminserter.hxx
@@ -33,6 +33,8 @@
 #include "osl/thread.h"
 #include "rtl/ustring.hxx"
 
+// Include this header to support rtl::OUString in CPPUNIT_ASSERT macros.
+
 template< typename charT, typename traits > std::basic_ostream<charT, traits> &
 operator <<(
     std::basic_ostream<charT, traits> & stream, rtl::OUString const & string)
diff --git a/test/inc/test/toabsolutefileurl.hxx b/test/inc/test/toabsolutefileurl.hxx
index 602dc9d0b435..5828a050fb75 100644
--- a/test/inc/test/toabsolutefileurl.hxx
+++ b/test/inc/test/toabsolutefileurl.hxx
@@ -34,6 +34,8 @@ namespace rtl { class OUString; }
 
 namespace test {
 
+// Convert a pathname in system notation, potentially relative to the process's
+// current working directory, to an absolute file URL:
 OOO_DLLPUBLIC_TEST rtl::OUString toAbsoluteFileUrl(
     rtl::OUString const & relativePathname);
 
diff --git a/test/source/java/OfficeConnection.java b/test/source/java/OfficeConnection.java
index d4817cb5d20b..6a7ecd277758 100644
--- a/test/source/java/OfficeConnection.java
+++ b/test/source/java/OfficeConnection.java
@@ -40,7 +40,14 @@ import java.util.Map;
 import java.util.UUID;
 import static org.junit.Assert.*;
 
+/** Start up and shut down an OOo instance.
+
+    Details about the OOo instance are tunneled in via
+    org.openoffice.test.arg.... system properties.
+*/
 public final class OfficeConnection {
+    /** Start up an OOo instance.
+    */
     public void setUp() throws Exception {
         description = "pipe,name=oootest" + UUID.randomUUID();
         ProcessBuilder pb = new ProcessBuilder(
@@ -79,6 +86,8 @@ public final class OfficeConnection {
         }
     }
 
+    /** Shut down the OOo instance.
+    */
     public void tearDown()
         throws InterruptedException, com.sun.star.uno.Exception
     {
@@ -107,15 +116,17 @@ public final class OfficeConnection {
         assertTrue(errTerminated);
     }
 
-    //TODO: get rid of this hack
-    public String getDescription() {
-        return description;
-    }
-
+    /** Obtain the service factory of the running OOo instance.
+    */
     public XMultiServiceFactory getFactory() {
         return factory;
     }
 
+    //TODO: get rid of this hack for legacy qa/unoapi tests
+    public String getDescription() {
+        return description;
+    }
+
     private static String getArgument(String name) {
         return System.getProperty("org.openoffice.test.arg." + name);
     }