removing leading stars in documentation strings

1 files changed, 89 insertions, 93 deletions

diff --git a/sal/inc/rtl/uuid.h b/sal/inc/rtl/uuid.h
index 8257adaa6040..363b2d3b4f6c 100644
--- a/sal/inc/rtl/uuid.h
+++ b/sal/inc/rtl/uuid.h
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: uuid.h,v $
  *
- *  $Revision: 1.4 $
+ *  $Revision: 1.5 $
  *
- *  last change: $Author: svesik $ $Date: 2000-12-06 10:57:59 $
+ *  last change: $Author: jsc $ $Date: 2001-04-26 13:34:01 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -65,100 +65,97 @@
 #include <sal/types.h>
 #include <rtl/string.h>
 
-/***
- * (from <draft-leach-uuids-guids-01.txt> )
- * Specification
- *
- * A UUID is an identifier that is unique across both space and time,
- * with respect to the space of all UUIDs. To be precise, the UUID
- * consists of a finite bit space. Thus the time value used for
- * constructing a UUID is limited and will roll over in the future
- * (approximately at A.D. 3400, based on the specified algorithm). A
- * UUID can be used for multiple purposes, from tagging objects with an
- * extremely short lifetime, to reliably identifying very persistent
- * objects across a network.
- *
- * The generation of UUIDs does not require that a registration
- * authority be contacted for each identifier. Instead, it requires a
- * unique value over space for each UUID generator. This spatially
- * unique value is specified as an IEEE 802 address, which is usually
- * already available to network-connected systems. This 48-bit address
- * can be assigned based on an address block obtained through the IEEE
- * registration authority.
- *
- *****/
+/**
+    (from <draft-leach-uuids-guids-01.txt> )
+    Specification
+
+    A UUID is an identifier that is unique across both space and time,
+    with respect to the space of all UUIDs. To be precise, the UUID
+    consists of a finite bit space. Thus the time value used for
+    constructing a UUID is limited and will roll over in the future
+    (approximately at A.D. 3400, based on the specified algorithm). A
+    UUID can be used for multiple purposes, from tagging objects with an
+    extremely short lifetime, to reliably identifying very persistent
+    objects across a network.
+
+    The generation of UUIDs does not require that a registration
+    authority be contacted for each identifier. Instead, it requires a
+    unique value over space for each UUID generator. This spatially
+    unique value is specified as an IEEE 802 address, which is usually
+    already available to network-connected systems. This 48-bit address
+    can be assigned based on an address block obtained through the IEEE
+    registration authority.
+ */
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
- * Generates a new UUID (Universally Unique IDentifier).
- * If available, the ethernetaddress of a networkcard is used, otherwise
- * a 6 Byte random number is generated( for which rtlRandomPool is used ).
- *
- *
- * @param pTargetUUID          pointer to at least 16 bytes of memory. After the call it contains
- *                             the newly generated uuid in network byte order.
- * @param pPredecessorUUID     pointer to the previously generated uuid in network byte
- *                             order. The generator reuses the 6-Byte random value
- *                             and the two byte context value and ensures,
- *                             that pTargetUUID is generated with a later timestamp.
- *                             Set pPredecessorUUID to 0 if no predecessor is available.
- *                             The caller is responsible for making the value persistent
- *                             (if desired).
- * @param bUseEthernetAddress  if sal_True, the generator uses the ethernet address of a
- *                             network card (if available). <br>
- *                             if sal_False, the generator generates a new 6-Byte random
- *                             value each time it is called with pPredecessorUUID = 0.
- *
- **/
+    Generates a new UUID (Universally Unique IDentifier).
+    If available, the ethernetaddress of a networkcard is used, otherwise
+    a 6 Byte random number is generated( for which rtlRandomPool is used ).
+
+
+    @param pTargetUUID          pointer to at least 16 bytes of memory. After the call it contains
+                                the newly generated uuid in network byte order.
+    @param pPredecessorUUID     pointer to the previously generated uuid in network byte
+                                order. The generator reuses the 6-Byte random value
+                                and the two byte context value and ensures,
+                                that pTargetUUID is generated with a later timestamp.
+                                Set pPredecessorUUID to 0 if no predecessor is available.
+                                The caller is responsible for making the value persistent
+                                (if desired).
+    @param bUseEthernetAddress  if sal_True, the generator uses the ethernet address of a
+                                network card (if available). <br>
+                                if sal_False, the generator generates a new 6-Byte random
+                                value each time it is called with pPredecessorUUID = 0.
+ */
 void SAL_CALL rtl_createUuid( sal_uInt8 *pTargetUUID ,
                               const sal_uInt8 *pPredecessorUUID,
                               sal_Bool bUseEthernetAddress );
 
-/****
- * uuid_compare --  Compare two UUID's "lexically" and return
- *        -1   u1 is lexically before u2
- *         0   u1 is equal to u2
- *         1   u1 is lexically after u2
- *
- *  Note:   lexical ordering is not temporal ordering!
- *  Note:   For equalnesschecking, a memcmp(pUUID1,pUUID2,16) is more efficient
- ****/
+/**
+    uid_compare --  Compare two UUID's "lexically" and return
+          -1   u1 is lexically before u2
+           0   u1 is equal to u2
+           1   u1 is lexically after u2
+
+    Note:   lexical ordering is not temporal ordering!
+    Note:   For equalnesschecking, a memcmp(pUUID1,pUUID2,16) is more efficient
+ */
 sal_Int32 SAL_CALL rtl_compareUuid( const sal_uInt8 *pUUID1 , const sal_uInt8 *pUUID2 );
 
-/****
- * The version 3 UUID is meant for generating UUIDs from "names" that
- * are drawn from, and unique within, some "name space". Some examples
- * of names (and, implicitly, name spaces) might be DNS names, URLs, ISO
- * Object IDs (OIDs), reserved words in a programming language, or X.500
- * Distinguished Names (DNs); thus, the concept of name and name space
- * should be broadly construed, and not limited to textual names.
- *
- * The requirements for such UUIDs are as follows:
- *
- * - The UUIDs generated at different times from the same name in the
- *   same namespace MUST be equal
- *
- * - The UUIDs generated from two different names in the same namespace
- *   should be different (with very high probability)
- *
- * - The UUIDs generated from the same name in two different namespaces
- *   should be different with (very high probability)
- *
- * - If two UUIDs that were generated from names are equal, then they
- *   were generated from the same name in the same namespace (with very
- *   high probability).
- *
- * @param pTargetUUID pointer to at least 16 bytes of memory. After the call
- *                    it contains the newly generated uuid in network byte order.
- * @param pNameSpaceUUID The namespace uuid. Below are some predefined ones,
- *                       but any arbitray uuid can be used as namespace.
- *
- * @param pName the name
- *
- ****/
+/**
+    The version 3 UUID is meant for generating UUIDs from "names" that
+    are drawn from, and unique within, some "name space". Some examples
+    of names (and, implicitly, name spaces) might be DNS names, URLs, ISO
+    Object IDs (OIDs), reserved words in a programming language, or X.500
+    Distinguished Names (DNs); thus, the concept of name and name space
+    should be broadly construed, and not limited to textual names.
+
+    The requirements for such UUIDs are as follows:
+
+    - The UUIDs generated at different times from the same name in the
+      same namespace MUST be equal
+
+    - The UUIDs generated from two different names in the same namespace
+      should be different (with very high probability)
+
+    - The UUIDs generated from the same name in two different namespaces
+      should be different with (very high probability)
+
+    - If two UUIDs that were generated from names are equal, then they
+      were generated from the same name in the same namespace (with very
+      high probability).
+
+    @param pTargetUUID pointer to at least 16 bytes of memory. After the call
+                       it contains the newly generated uuid in network byte order.
+    @param pNameSpaceUUID The namespace uuid. Below are some predefined ones,
+                          but any arbitray uuid can be used as namespace.
+
+    @param pName the name
+ */
 void SAL_CALL rtl_createNamedUuid(
     sal_uInt8  *pTargetUUID,
     const sal_uInt8  *pNameSpaceUUID,
@@ -167,11 +164,10 @@ void SAL_CALL rtl_createNamedUuid(
 
 
 
-/****
- * Predefined Namespaces
- * (Use them the following way : sal_uInt8 aNsDNS[16])  = RTL_UUID_NAMESPACE_DNS;
- *
- ****/
+/**
+    Predefined Namespaces
+    (Use them the following way : sal_uInt8 aNsDNS[16])  = RTL_UUID_NAMESPACE_DNS;
+ */
 /* 6ba7b810-9dad-11d1-80b4-00c04fd430c8 */
 #define RTL_UUID_NAMESPACE_DNS {\
       0x6b,0xa7,0xb8,0x10,\
@@ -206,10 +202,10 @@ void SAL_CALL rtl_createNamedUuid(
 
 
 /**
- * This macro must have a value below the system time resolution of the
- * system. The uuid routines use this value  as an upper limit for adding ticks to the
- * the predecessor time value if system times are equal.
- ***/
+    This macro must have a value below the system time resolution of the
+    system. The uuid routines use this value  as an upper limit for adding ticks to the
+    the predecessor time value if system times are equal.
+ */
 #ifdef SAL_W32
 #define UUID_SYSTEM_TIME_RESOLUTION_100NS_TICKS 1000
 #elif LINUX