Ignore:
Timestamp:
Feb 3, 2007, 6:59:37 PM (19 years ago)
Author:
cinc
Message:

Added doxygen tags. Some minor changes to NOMClass.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/nom/class_c/nomobj.c

    r210 r219  
    4646#include "nomobj.ih"
    4747
     48/**
    4849
     50    \brief This function implements the method nomInit() of class NOMObject.
     51 */
    4952NOM_Scope void  NOMLINK impl_NOMObject_nomInit(NOMObject *nomSelf, CORBA_Environment *ev)
    5053{ 
    … …  
    5356}
    5457
     58/**
     59
     60    \brief This function implements the method nomUnInit() of class NOMObject.
     61 */
    5562NOM_Scope void  NOMLINK impl_NOMObject_nomUnInit(NOMObject *nomSelf, CORBA_Environment *ev)
    5663{
    … …  
    6168}
    6269
     70/**
     71
     72    \brief This function implements the method nomGetSize() of class NOMObject.
     73 */
    6374NOM_Scope CORBA_long NOMLINK impl_NOMObject_nomGetSize(NOMObject* nomSelf, CORBA_Environment *ev)
    6475{
    … …  
    7384}
    7485
     86/**
     87
     88    \brief This function implements the method delete() of class NOMObject.
     89
     90    It calls nomUnInit() to give the object a chance of freeing system resources. Afterwards
     91    the memory occupied by the object is given back to the system and the object is not
     92    accessible anymore.
     93 */
    7594NOM_Scope void NOMLINK impl_NOMObject_delete(NOMObject* nomSelf, CORBA_Environment *ev)
    7695{
    … …  
    88107}
    89108
    90 /*
    91   Gets the class object of this object.
    92 */
     109/**
     110
     111    \brief This function implements the method nomGetClass() of class NOMObject.
     112    It returns a pointer to the class object of this object.
     113
     114    \param nomSelf The pointer to the object.
     115    \param ev      Environment pointer or NULL.
     116    \retval PNOMClass A pointer to the class object for this object. This can never be NULL.
     117 */
    93118NOM_Scope PNOMClass NOMLINK impl_NOMObject_nomGetClass(NOMObject* nomSelf, CORBA_Environment *ev)
    94119{
    … …  
    98123}
    99124
    100 /*
    101   Create a new class of the kind the caller is. This method ensures that subclasses
    102   are properly handled without the need to override this method in every subclass.
     125/**
     126
     127   \brief This function implements the method new() of class NOMObject.
     128
     129  Create a new class of the kind the caller is. This method ensures that subclassing
     130  is properly handled without the need to override this method in every subclass.
     131 
     132  This method will get the class object of nomSelf () which may be any subclass
     133  of NOMObject) and call nomNew() on it creating
     134  a new object which has exactly the same class hierarchy as nomSelf.
    103135 */
    104136NOM_Scope PNOMObject NOMLINK impl_NOMObject_new(NOMObject* nomSelf, CORBA_Environment *ev)
Note: See TracChangeset for help on using the changeset viewer.