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

Timestamp:

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

Author:

cinc

Message:

Added doxygen tags. Renamed methods.

File:

• trunk/desktop/idl/wpnotebook.idl (modified) (3 diffs)

trunk/desktop/idl/wpnotebook.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 WPNoteBook class.
+*/
 #ifndef WPNOTEBOOK_IDL_INCLUDED
 #define WPNOTEBOOK_IDL_INCLUDED
@@ -50 +52 @@
 #include "nomnotebook.idl"
 
+/** \interface WPNoteBook
+    
+    This class implements settings notebooks for desktop objects.
+
+    Implementation is very preliminary.
+*/
 interface WPNoteBook : WPWindow
 {
   NOMCLASSVERSION(1, 0);
 
-  PNOMNoteBook wpQueryNoteBookObject();
-  void wpSetNoteBookObject(in PNOMNoteBook nomNBook);
+  PNOMNoteBook wpQueryNoteBook();
+  void wpSetNoteBook(in PNOMNoteBook nomNBook);
 
   NOMOVERRIDE(nomInit);