*** empty log message ***

1 files changed, 29 insertions, 12 deletions

diff --git a/apps/JAWS/clients/Caching/URL_Properties.h b/apps/JAWS/clients/Caching/URL_Properties.h
index 94b1129e53c..ec2f7f3a7de 100644
--- a/apps/JAWS/clients/Caching/URL_Properties.h
+++ b/apps/JAWS/clients/Caching/URL_Properties.h
@@ -32,6 +32,8 @@ class ACE_Export ACE_WString_Helper
 public:
   static size_t bsize (const ACE_WString *wstr);
   // Returns the actual size required to contain the ACE_WString.
+  // Nanbor, is there a reason you called this <bsize> rather than
+  // just <size>?  I think I like <size> better!
 
   static size_t encode (void *buf, ACE_WString *wstr);
   // Encode <wstr> into <buf> for network communication.
@@ -49,13 +51,18 @@ class ACE_Export ACE_URL_Property
   //
   // = DESCRIPTION
   //     A property contains a <name> and a <value>.
+// Nanbor, please add more description of what is typically *done* with a URL property.
 {
 public:
-  ACE_URL_Property (const char *name = 0, const char *value=0);
+  ACE_URL_Property (const char *name = 0,
+		    const char *value=0);
   // Create a property.
 
   ACE_URL_Property (const ACE_USHORT16 *name,
 		    const ACE_USHORT16 *value);
+  // Nanbor, please make sure that you comment these interfaces.  In
+  // particular, does this interface distinguish between UNICODE and
+  // non-UNICODE?
 
   ACE_URL_Property (const ACE_URL_Property &p);
   // Copy constructor.
@@ -70,27 +77,28 @@ public:
   // Equals operator.
 
   int operator!= (const ACE_URL_Property &rhs) const;
-  // Not equals operator.
+  // Inequality operator.
 
+  // = Query property name.
   ACE_WString *name_rep (void);
   const ACE_WString *name (void) const;
-  // Query property name.
 
+  // = Set property name.
   void name (const ACE_USHORT16 *n);
   void name (const char *n);
-  // Set property name.
 
+  // = Query property value.
   ACE_WString *value_rep (void);
   const ACE_WString *value (void) const;
-  // Query property value.
 
+  // = Set property value. 
   void value (const ACE_USHORT16 *v);
   void value (const char *v);
-  // Set property value. 
 
-  // Some helper functions for encoding and decoding.
+  // = Helper functions for encoding and decoding.
   size_t bsize (void) const;
   // Returns memory size required to encode this object.
+  // Nanbor, can we make this <size> rather than <bsize>?
 
   size_t encode (void *buf) const;
   // Encodes this object into buf for network transmission.
@@ -103,6 +111,10 @@ public:
   // Dump out this object for debug.
   
 protected:
+  // Nanbor, is there a particular reason that you're using dynamic
+  // memory allocation here?  Can you just use instances of
+  // ACE_WString that aren't allocated dynamically or is there some
+  // reason why you need pointers?
   ACE_WString *name_;
   // Property name pointer.
   
@@ -110,6 +122,7 @@ protected:
   // Property value.
 } ;
 
+// Nanbor, please add a comment here.
 typedef ACE_Array<ACE_URL_Property> ACE_URL_Property_Seq;
 
 class ACE_Export ACE_URL_Offer
@@ -119,6 +132,7 @@ class ACE_Export ACE_URL_Offer
   // = DESCRIPTION
   //     A URL offer is defined by a <url> and an
   //     <ACE_URL_Property_Seq>.
+// Nanbor, please explain how an offer is typically *used*.
 {
 public:
   ACE_URL_Offer (const size_t size = 1, const char *url = 0);
@@ -139,24 +153,25 @@ public:
   int operator!= (const ACE_URL_Offer &rhs) const;
   // Inequality operator.
 
+  // = Get URL string.
   ACE_WString *url_rep (void);
   const ACE_WString *url (void) const;
-  // Get URL string.
 
+  // = Set URL.
   void url (const char *url);
   void url (const ACE_USHORT16 *url);
-  // Set URL.
 
   ACE_URL_Property_Seq &url_properties (void);
   // Get properties of this offer.
   
   void url_properties (const ACE_URL_Property_Seq &prop);
-  // Set properties of this offer.  This operation
-  // virtually get a copy of the passed in prop.
+  // Set properties of this offer.  This operation virtually get a
+  // copy of the passed in prop.
 
-  // Some helper functions for encoding and decoding.
+  // = Helper functions for encoding and decoding.
   size_t bsize (void) const;
   // Returns memory size required to encode this object.
+  // Nanbor, can you please make this <size>?
 
   size_t encode (void *buf) const;
   // Encodes this object into buf for network transmission.
@@ -176,6 +191,8 @@ protected:
   // Properties associate with this offer.
 };
 
+// Nanbor, please add a comment here.
+
 typedef ACE_Array<ACE_URL_Offer> ACE_URL_Offer_Seq;
 
 #if defined (__ACE_INLINE__)