Changeset 245 for trunk/desktop/idl/wpfilesystem.idl

Timestamp:

Mar 10, 2007, 4:21:32 PM (18 years ago)

Author:

cinc

Message:

Added doxygen tags.

File:

• trunk/desktop/idl/wpfilesystem.idl (modified) (2 diffs)

trunk/desktop/idl/wpfilesystem.idl

@@ -32 +32 @@
 *
 * ***** END LICENSE BLOCK ***** */
+/** \file 
+    
+*/
 
 #ifndef wpfsys_idl
@@ -45 +48 @@
 NOMMETACLASS(M_WPFileSystem);
 
+/** \interface WPFileSystem
+
+    Any object which represents a filesystem object is a subclass of this class, e.g.
+    WPDataFile or WPFolder.
+ */
 interface WPFileSystem : WPObject
 {
   NOMCLASSVERSION(1, 0);
 
-  void tstSetFullPath(in string fullPath);   
+  void tstSetFullPath(in string fullPath);
+  /**
+     Query the filename of this object.
+
+     \remarks This name may be different from the displayed title because of filename
+     encoding on disk.
+
+     \param bFullPath If set to TRUE the fully qualified path is returned.
+   */
   PNOMPath wpQueryFileName(in boolean bFullPath);
 
+  /**
+     wpMoveObject() must be overriden to physically move a file or folder when requested.
+     The method implementation of WPObject only handles the graphical representation on the
+     desktop by inserting icons into folder windows.
+   */
   NOMOVERRIDE(wpMoveObject);
   NOMOVERRIDE(wpCopyObject);