Changeset 248 for trunk/desktop/idl/m_wpobject.idl

Timestamp:

Mar 10, 2007, 9:40:28 PM (18 years ago)

Author:

cinc

Message:

Added doxygen tags. Renamed methods.

File:

• trunk/desktop/idl/m_wpobject.idl (modified) (4 diffs)

trunk/desktop/idl/m_wpobject.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.
 *
@@ -32 +32 @@
 *
 * ***** END LICENSE BLOCK ***** */
+/** \file 
+    Class definition file for M_WPObject class.
+*/
 
 #ifndef M_WPOBJECT_IDL_INCLUDED
@@ -43 +46 @@
 #include "nomstring.idl"
 
+/** \interface M_WPObject
+
+    This class is the metaclass for the WPObject class.
+ */
 interface M_WPObject : NOMClass
 {
@@ -49 +56 @@
   gpointer wpclsQueryIcon();
   boolean wpclsSetIcon(in gpointer pNewIcon);
+
+  /**
+     This method returns the class title for classes for which this is the metaclass.
+   */
   string wpclsQueryTitle();
+
+  /**
+     Method to be overriden by metaclasses when they need to do some setup.
+
+     \remark Desktop metaclasses should override this method instead of nomInit().
+
+     \par How to override:
+     This method should be overriden by classes which need initialization. The parent
+     must be called first.
+
+     \sa wpclsUnInitData()
+   */
   void wpclsInitData();
+
+  /**
+     Method to be overriden by classes when they need to do some unititialization work.
+
+     \remark Desktop metaclasses should override this method instead of nomUnInit().
+
+     \par How to override
+     This method should be overriden by classes which need uninitialization. The parent must
+     be called last.
+
+     \sa wpclsInitData()
+   */
   void wpclsUnInitData();