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

Timestamp:

Feb 4, 2007, 3:17:09 PM (19 years ago)

Author:

cinc

Message:

Added doxygen documentation.

File:

• trunk/foundation/idl/nomfilepath.idl (modified) (1 diff)

trunk/foundation/idl/nomfilepath.idl

@@ -41 +41 @@
 NOMCLASSNAME(NOMPath);
 
+/** \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
 {
+  /**
+     The current version of this class is 1.0
+   */
   NOMCLASSVERSION(1, 0);
 
+  /**
+     Append a path to the string. A path separator will be added to the current path
+     if necessary and the given string appended. If the given string starts with a separator
+     no additional separator will be added to the path prior to appending. If the given string
+     starts with a separator and the current path ends with a separator the ending separator
+     will be removed before appending.
+
+     \remark
+     Note that there's no check if the input string is an absolute path. So if an absolute path
+     is given as input the resulting path may not be valid.
+
+     \return
+     The method returns a new NOMPath instance after appending.
+
+     \sa append(), appendCString()
+   */
   PNOMPath appendPath(in PNOMPath nomPath);   
+
+  /**
+     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.
+
+     \return
+     This method always returns a new instance of a NOMPath owned by the caller.
+
+     \sa append(), appendPath()
+   */
   PNOMPath appendSeparator();
+
+  /**
+     Strips the path separator from the end of a path if there's one.
+
+     \return
+     This method always returns a new instance of a NOMPath owned by the caller.
+
+     \sa appendSeparator()
+   */
   PNOMPath stripSeparator();
+
+  /**
+
+     \remark This method is only implemented for OS/2.
+
+     \return
+     Returns TRUE if the given path is absolute. On OS/2 this means it starts with a letter
+     followed by a colon.
+   */
   boolean  pathIsAbsolute();
+ 
+ /**
+     Returns the root of the current path. On OS/2 that is a letter followed by a colon.
+     
+     \remark This method is only implemented for OS/2.
+
+     \return
+     This method always returns a new instance of a NOMPath owned by the caller.
+  */
   PNOMPath queryRoot();
+
+  /**
+     This method strips all characters from the beginning of a path till the first
+     directory separator and also this first separator. If there's no separator in
+     the path a zero length path is returned.
+
+     \return
+     This method always returns a new instance of a NOMPath owned by the caller.
+     
+     \sa queryPathBegin()
+  */
   PNOMPath erasePathBegin();
+
+  /**
+     Returns the part of the path up to the first directory separator ('\' on OS/2).
+     If there's no directory separator the whole path is returned. This method does
+     not remove the part from the given path. Use erasePathBegin() to do that.
+
+     \remark This method only works for null terminated string.
+
+     \return
+     A new NOMString object holding the first part of a path.
+
+     \sa erasePathBegin()
+   */
   PNOMPath queryPathBegin();
 };