Changeset 227 for trunk/foundation/idl/nomfilepath.idl

Timestamp:

Feb 4, 2007, 10:51:43 PM (19 years ago)

Author:

cinc

Message:

Changed string and path classes not to return always copies but only when necessary.

File:

• trunk/foundation/idl/nomfilepath.idl (modified) (6 diffs)

trunk/foundation/idl/nomfilepath.idl

@@ -16 +16 @@
 * The Initial Developer of the Original Code is
 * netlabs.org: Chris Wohlgemuth <cinc-ml@netlabs.org>.
-* Portions created by the Initial Developer are Copyright (C) 2005-2006
+* Portions created by the Initial Developer are Copyright (C) 2005-2007
 * the Initial Developer. All Rights Reserved.
 *
@@ -43 +43 @@
 /** \class NOMPath
     NOMPath is a specialized string class for dealing with file or directory paths.
-    As with NOMString the NOMPath class is always working on copies.
  */
 interface NOMPath : NOMString
@@ -58 +57 @@
      starts with a separator and the current path ends with a separator the ending separator
      will be removed before appending.
+     If no input path is given only a separator is appended if necessary.
 
      \remark
@@ -64 +64 @@
 
      \return
-     The method returns a new NOMPath instance after appending.
+     The method returns the same NOMPath instance after appending.
 
      \sa append(), appendCString()
@@ -72 +72 @@
   /**
      Append a separator to the path. If the path already has a separator at the end this method
-     does nothing other than returning a new path object. If the given path has zero length
-     a path object only holding a separator is returned.
+     does nothing other than returning the path object. If the given path has zero length
+     the path object only holding a separator is returned.
+
+     \remark The returned string object is not newly allocated. Be aware that the string data
+     held by the object may. 
 
      \return
-     This method always returns a new instance of a NOMPath owned by the caller.
+     This method returns the NOMPath. This is not a copy. 
 
      \sa append(), appendPath()
@@ -86 +89 @@
 
      \return
-     This method always returns a new instance of a NOMPath owned by the caller.
+     This method returns the same instance of a NOMPath.
 
      \sa appendSeparator()