Changeset 219 for trunk/nom/class_c


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

Added doxygen tags. Some minor changes to NOMClass.

Location:
trunk/nom/class_c
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/nom/class_c/nomcls.c

    r210 r219  
    6666}
    6767
    68 NOM_Scope CORBA_Object NOMLINK impl_NOMClass_nomNew(NOMClass* nomSelf, CORBA_Environment *ev)
     68/**
     69   \brief Function which implements the nomNew() method of NOMClass.
     70 */
     71NOM_Scope PNOMObject NOMLINK impl_NOMClass_nomNew(NOMClass* nomSelf, CORBA_Environment *ev)
    6972{
    7073  NOMClassData* nomThis=NOMClassGetData(nomSelf);
    … …  
    8790}
    8891
    89 NOM_Scope CORBA_Object NOMLINK impl_NOMClass_nomRenewNoInit(NOMClass* nomSelf,
    90                                                             const CORBA_Object nomObj,
    91                                                             CORBA_Environment *ev)
     92/**
     93   \brief Function which implements the nomRenewNoInit() method of NOMClass.
     94 */
     95NOM_Scope PNOMObject NOMLINK impl_NOMClass_nomRenewNoInit(NOMClass* nomSelf,
     96                                                          const gpointer nomObj,
     97                                                          CORBA_Environment *ev)
    9298{
    9399  NOMClassPriv *ncp;
    … …  
    116122}
    117123
    118 NOM_Scope CORBA_Object NOMLINK impl_NOMClass_nomRenew(NOMClass* nomSelf, const CORBA_Object nomObj,
    119                                                       CORBA_Environment *ev)
     124/**
     125   \brief Function which implements the nomRenew() method of NOMClass.
     126 */
     127NOM_Scope PNOMObject NOMLINK impl_NOMClass_nomRenew(NOMClass* nomSelf, const gpointer nomObj,
     128                                                    CORBA_Environment *ev)
    120129{
    121130  _nomRenewNoInit(nomSelf, nomObj, NULLHANDLE);
    … …  
    128137
    129138
    130 NOM_Scope CORBA_string NOMLINK impl_NOMClass_nomAllocate(NOMClass* nomSelf, const CORBA_long ulSize,
     139/**
     140   \brief Function which implements the nomAllocate() method of NOMClass.
     141 */
     142NOM_Scope gpointer NOMLINK impl_NOMClass_nomAllocate(NOMClass* nomSelf, const CORBA_long ulSize,
    131143                                                         CORBA_Environment *ev)
    132144{
    … …  
    136148}
    137149
     150/**
     151   Function which implements the nomGetName() method of NOMClass.
     152*/
    138153NOM_Scope CORBA_string NOMLINK impl_NOMClass_nomGetName(NOMClass* nomSelf, CORBA_Environment *ev)
    139154{
    … …  
    142157
    143158
    144 NOM_Scope void NOMLINK impl_NOMClass_nomDeallocate(NOMClass* nomSelf, const CORBA_char * memptr, CORBA_Environment *ev)
     159/**
     160   \brief Function which implements the nomDeallocate() method of NOMClass.
     161 */
     162NOM_Scope void NOMLINK impl_NOMClass_nomDeallocate(NOMClass* nomSelf, const gpointer memptr, CORBA_Environment *ev)
    145163{
    146164  NOMFree((nomToken)memptr);
    … …  
    148166
    149167
     168/**
     169   \brief Function which implements the nomSetObjectCreateInfo() method of NOMClass.
     170 */
    150171NOM_Scope void NOMLINK impl_NOMClass_nomSetObjectCreateInfo(NOMClass* nomSelf, const gpointer ncpObject,
    151172                                                            CORBA_Environment *ev)
    … …  
    159180}
    160181
     182/**
     183   \brief Function which implements the nomGetObjectCreateInfo() method of NOMClass.
     184 */
    161185NOM_Scope gpointer NOMLINK impl_NOMClass_nomGetObjectCreateInfo(NOMClass* nomSelf, CORBA_Environment *ev)
    162186{
    … …  
    166190}
    167191
     192/**
     193   \brief Function which implements the nomClassReady() method of NOMClass.
     194 */
    168195NOM_Scope void NOMLINK impl_NOMClass_nomClassReady(NOMClass* nomSelf, CORBA_Environment *ev)
    169196{

  • 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.