#88337# Docu reviewed

1 files changed, 39 insertions, 26 deletions

diff --git a/sal/inc/rtl/bootstrap.h b/sal/inc/rtl/bootstrap.h
index 1cf92dff1251..8e5a91d5d2d0 100644
--- a/sal/inc/rtl/bootstrap.h
+++ b/sal/inc/rtl/bootstrap.h
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: bootstrap.h,v $
  *
- *  $Revision: 1.2 $
+ *  $Revision: 1.3 $
  *
- *  last change: $Author: kr $ $Date: 2001-08-30 11:51:36 $
+ *  last change: $Author: jbu $ $Date: 2001-10-24 10:51:08 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -68,80 +68,90 @@ extern "C" {
 #endif
 
 /**
+   @HTML
+   @file
+
    The described concept provides a platform independent way to access
    minimum bootstrap settings for every application by excplitly or
-   implicitly passing the values to the application.
+   implicitly passing the values to the application.<p>
 
-   4-LEVEL STRATEGY FOR RETRIEVAL OF BOOTSTRAP VALUES :
+   4-LEVEL STRATEGY FOR RETRIEVAL OF BOOTSTRAP VALUES :<p>
 
    The 1st level is tried first. On failure,
    the next level is tried. Every query starts at the first level again, so
-   that one setting may be taken from the 3rd and one from the 1st level.
+   that one setting may be taken from the 3rd and one from the 1st level.<p>
 
    1st level: command line arguments. A "-env:SETTINGNAME=value" is given on
    command line. This allows to give an application a certain setting, even
    if an ini-file exists (espicially useful for e.g. daemons that want to
-   start an executable with dynamical changing settings).
+   start an executable with dynamical changing settings).<p>
 
    2nd level: ini-files. Every application looks for an ini-file.
    The filename defaults to /absoulte/path/to/executable[rc|.ini]
    (without .bin or .exe suffix). The ini-filename can be
    set by the special command line parameter
    '-env:INIFILENAME=/absolute/path/to/inifile' at runtime or it may
-   be set at compiletime by an API-call.
+   be set at compiletime by an API-call.<p>
 
    3rd level: environment variables. The application tries to get the
-   setting from the environment.
+   setting from the environment.<p>
 
    4th level: default. An application can have some default settings decided
    at compile time, which allow the application to run even with no
-   deployment settings.
+   deployment settings. <p>
 
    If neither of the 4 levels leads to an successful retrieval of the value
-   (no default possible), the application may  fail to start.
+   (no default possible), the application may  fail to start.<p>
 
-   NAMING CONVENTIONS
+   NAMING CONVENTIONS <p>
 
    Naming conventions for names of bootstrap values :
    Names may only include characters, that are allowed charcters for
    environment variables. This excludes '.', ' ', ';', ':' and any non-ascii
-   character. Names are case insensitive.
+   character. Names are case insensitive.<p>
 
    The ini-file is only allowed to have one section, which must be named '[Bootstrap]'.
    The section may be omitted.
    The section name does not appear in the name of the corresponding
    environment variable or commandline arg.
-   Values maybe arbitrary unicode strings, they must be encoded in UTF8.
+   Values maybe arbitrary unicode strings, they must be encoded in UTF8.<p>
 
-   Example:
+   Example:<p>
 
    in an ini-file:
+   <code>
    [Sectionname]
    Name=value
+   </code><p>
 
    as commandline arg:
-   -env:Name=value
+   <code>-env:Name=value</code><p>
 
    as environment
+   <code>
    setenv Name value
    set Name=value
+   </code><p>
 
    SPECIAL VARIABLES:
 
-   - INIFILENAME
+   <ul>
+   <li> INIFILENAME<br>
      This variable allows to set the inifilename. This makes only sense, if the filename
      is different than the executable file name. It must be given on command line. If it is
      given the executable ini-file is ignored.
+   </li>
 */
 
 /** may be called by an application to set an ini-filename.
 
+    <p>
     Must be called before rtl_bootstrap_get(). May not be called twice.
     If it is never called, a the filename executable.ini (win)
     or execuablerc (unx) is assumed.
 
-    @pName Name of the inifile with path but WITHOUT
-           suffix (.ini or rc)
+    @param pName Name of the inifile with path but WITHOUT
+    suffix (.ini or rc)
 */
 void SAL_CALL rtl_bootstrap_setIniFileName( rtl_uString *pName );
 
@@ -149,19 +159,18 @@ void SAL_CALL rtl_bootstrap_setIniFileName( rtl_uString *pName );
    @param ppValue
         out parameter. Contains always a valid rtl_uString pointer.
    @param pName
-            The name of the bootstrap setting to be
-        retrieved.
+            The name of the bootstrap setting to be     retrieved.
    @param pDefault
         maybe NULL. If once the default is
            returned, successive calls always return this
            default value, even when called with different
            defaults.
 
-   @return sal_True, when a value could be retrieved successfully
-           sal_False, when none of the 4 methods gave a value. ppValue
+   @return <code>sal_True</code>, when a value could be retrieved successfully,
+           <code>sal_False</code>, when none of the 4 methods gave a value. ppValue
            then contains ane empty string.
            When a pDefault value is given, the function returns always
-           sal_True.
+           <code>sal_True</code>.
 */
 sal_Bool SAL_CALL rtl_bootstrap_get( rtl_uString *pName, rtl_uString **ppValue, rtl_uString *pDefault );
 
@@ -178,14 +187,14 @@ rtlBootstrapHandle SAL_CALL rtl_bootstrap_args_open(rtl_uString * pIniName);
 
 /**
    Closes a boostrap agument container.
-   @ param handle [in]     The handle got by <code>rtl_bootstrap_args_open</code>
+   @param handle [in]     The handle got by <code>rtl_bootstrap_args_open()</code>
 */
 void SAL_CALL rtl_bootstrap_args_close(rtlBootstrapHandle handle);
 
 /**
-   @param handle   [in]     The handle got by <code>rtl_bootstrap_args_open</code>
+   @param handle   [in]     The handle got by <code>rtl_bootstrap_args_open()</code>
    @param pName    [in]     The name of the variable to be retrieved
-   @param ppValue  [out]    The result of the retrieval
+   @param ppValue  [out]    The result of the retrieval. *ppValue may be null in case of failure.
    @param pDefault [in]     The default value for the retrieval, may be <code>NULL</code>
 
    @return                  The status of the retrieval, <code>sal_True</code> on success.
@@ -193,6 +202,10 @@ void SAL_CALL rtl_bootstrap_args_close(rtlBootstrapHandle handle);
 sal_Bool SAL_CALL rtl_bootstrap_get_from_handle(rtlBootstrapHandle handle, rtl_uString *pName, rtl_uString **ppValue, rtl_uString *pDefault);
 
 
+/** Returns the name of the inifile associated with this handle.
+
+   @param ppIniName contains after the call the name of the ini-filename.
+*/
 void SAL_CALL rtl_bootstrap_get_iniName_from_handle(rtlBootstrapHandle handle, rtl_uString ** ppIniName);