Changeset 248 for trunk/desktop/idl


Ignore:
Timestamp:
Mar 10, 2007, 9:40:28 PM (19 years ago)
Author:
cinc
Message:

Added doxygen tags. Renamed methods.

Location:
trunk/desktop/idl
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • trunk/desktop/idl/m_wpdatafile.idl

    r206 r248  
    1616* The Initial Developer of the Original Code is
    1717* netlabs.org: Chris Wohlgemuth <cinc-ml@netlabs.org>.
    18 * Portions created by the Initial Developer are Copyright (C) 2005-2006
     18* Portions created by the Initial Developer are Copyright (C) 2005-2007
    1919* the Initial Developer. All Rights Reserved.
    2020*
    … …  
    3232*
    3333* ***** END LICENSE BLOCK ***** */
     34/** \file
     35    Class definition file for M_WPDataFile class.
     36*/
     37
    3438#ifndef M_WPDATAFILE_IDL_INCLUDED
    3539#define M_WPDATAFILE_IDL_INCLUDED
    … …  
    4347#include "nomstring.idl"
    4448
     49/** \interface M_WPDataFile
     50
     51    This class is the metaclass for the WPDataFile class.
     52 */
    4553interface M_WPDataFile : M_WPFileSystem
    4654{

  • trunk/desktop/idl/m_wpfilesystem.idl

    r206 r248  
    1616* The Initial Developer of the Original Code is
    1717* netlabs.org: Chris Wohlgemuth <cinc-ml@netlabs.org>.
    18 * Portions created by the Initial Developer are Copyright (C) 2005-2006
     18* Portions created by the Initial Developer are Copyright (C) 2005-2007
    1919* the Initial Developer. All Rights Reserved.
    2020*
    … …  
    3232*
    3333* ***** END LICENSE BLOCK ***** */
     34/** \file
     35    Class definition file for M_WPObject class.
     36*/
    3437
    3538#ifndef M_WPFILESYSTEM_IDL_INCLUDED
    … …  
    4447#include "nomstring.idl"
    4548
     49/** \interface M_WPFileSystem
     50
     51    This class is the metaclass for the WPFileSystem class.
     52 */
    4653interface M_WPFileSystem : M_WPObject
    4754{
    4855  NOMCLASSVERSION(1, 0);
    4956
     57  /**
     58     Query the extensions for instances of this class.
     59   */
    5060  string wpclsQueryInstanceFilter();
    5161

  • trunk/desktop/idl/m_wpfolder.idl

    r206 r248  
    1616* The Initial Developer of the Original Code is
    1717* netlabs.org: Chris Wohlgemuth <cinc-ml@netlabs.org>.
    18 * Portions created by the Initial Developer are Copyright (C) 2005-2006
     18* Portions created by the Initial Developer are Copyright (C) 2005-2007
    1919* the Initial Developer. All Rights Reserved.
    2020*
    … …  
    3232*
    3333* ***** END LICENSE BLOCK ***** */
     34/** \file
     35    Class definition file for M_WPFolder class.
     36*/
     37
    3438#ifndef M_WPFOLDER_IDL_INCLUDED
    3539#define M_WPFOLDER_IDL_INCLUDED
    … …  
    4347#include "nomstring.idl"
    4448
     49/** \interface M_WPFolder
    4550
     51    This class is the metaclass for the WPFolder class.
     52 */
    4653interface M_WPFolder : M_WPDataFile
    4754{

  • trunk/desktop/idl/m_wpobject.idl

    r209 r248  
    1616* The Initial Developer of the Original Code is
    1717* netlabs.org: Chris Wohlgemuth <cinc-ml@netlabs.org>.
    18 * Portions created by the Initial Developer are Copyright (C) 2005-2006
     18* Portions created by the Initial Developer are Copyright (C) 2005-2007
    1919* the Initial Developer. All Rights Reserved.
    2020*
    … …  
    3232*
    3333* ***** END LICENSE BLOCK ***** */
     34/** \file
     35    Class definition file for M_WPObject class.
     36*/
    3437
    3538#ifndef M_WPOBJECT_IDL_INCLUDED
    … …  
    4346#include "nomstring.idl"
    4447
     48/** \interface M_WPObject
     49
     50    This class is the metaclass for the WPObject class.
     51 */
    4552interface M_WPObject : NOMClass
    4653{
    … …  
    4956  gpointer wpclsQueryIcon();
    5057  boolean wpclsSetIcon(in gpointer pNewIcon);
     58
     59  /**
     60     This method returns the class title for classes for which this is the metaclass.
     61   */
    5162  string wpclsQueryTitle();
     63
     64  /**
     65     Method to be overriden by metaclasses when they need to do some setup.
     66
     67     \remark Desktop metaclasses should override this method instead of nomInit().
     68
     69     \par How to override:
     70     This method should be overriden by classes which need initialization. The parent
     71     must be called first.
     72
     73     \sa wpclsUnInitData()
     74   */
    5275  void wpclsInitData();
     76
     77  /**
     78     Method to be overriden by classes when they need to do some unititialization work.
     79
     80     \remark Desktop metaclasses should override this method instead of nomUnInit().
     81
     82     \par How to override
     83     This method should be overriden by classes which need uninitialization. The parent must
     84     be called last.
     85
     86     \sa wpclsInitData()
     87   */
    5388  void wpclsUnInitData();
    5489

  • trunk/desktop/idl/wpnotebook.idl

    r189 r248  
    1616* The Initial Developer of the Original Code is
    1717* netlabs.org: Chris Wohlgemuth <cinc-ml@netlabs.org>.
    18 * Portions created by the Initial Developer are Copyright (C) 2005-2006
     18* Portions created by the Initial Developer are Copyright (C) 2005-2007
    1919* the Initial Developer. All Rights Reserved.
    2020*
    … …  
    3232*
    3333* ***** END LICENSE BLOCK ***** */
    34 
     34/** \file
     35    Class definition file for WPNoteBook class.
     36*/
    3537#ifndef WPNOTEBOOK_IDL_INCLUDED
    3638#define WPNOTEBOOK_IDL_INCLUDED
    … …  
    5052#include "nomnotebook.idl"
    5153
     54/** \interface WPNoteBook
     55   
     56    This class implements settings notebooks for desktop objects.
     57
     58    Implementation is very preliminary.
     59*/
    5260interface WPNoteBook : WPWindow
    5361{
    5462  NOMCLASSVERSION(1, 0);
    5563
    56   PNOMNoteBook wpQueryNoteBookObject();
    57   void wpSetNoteBookObject(in PNOMNoteBook nomNBook);
     64  PNOMNoteBook wpQueryNoteBook();
     65  void wpSetNoteBook(in PNOMNoteBook nomNBook);
    5866
    5967  NOMOVERRIDE(nomInit);

  • trunk/desktop/idl/wpobject.idl

    r245 r248  
    109109
    110110  /**
    111      Method to be overriden by objects when they need to do some setup.
     111     Method to be overriden by classes when they need to do some setup.
    112112
    113113     \remark Desktop classes should override this method instead of nomInit().
    … …  
    122122
    123123  /**
    124      Method to be overriden by objects when they need to do some unititialization work.
     124     Method to be overriden by classes when they need to do some unititialization work.
    125125
    126126     \remark Desktop classes should override this method instead of nomUnInit().
Note: See TracChangeset for help on using the changeset viewer.