DocTest
testing Doxygen for my C library
 All Data Structures Files Functions
Typedefs | Functions
DtMyObject.h File Reference

API for the DtMyObject class. More...

Go to the source code of this file.

Typedefs

typedef struct DtMyObject DtMyObject
 

Functions

void dt_my_object_delete (DtMyObject *obj)
 Destructor for DtMyObject class. More...
 
void * dt_my_object_get (DtMyObject *obj)
 Retrieve the data stored in this object. More...
 
DtMyObjectdt_my_object_new (void *data)
 Constructor for DtMyObject class. More...
 

Detailed Description

API for the DtMyObject class.

The DtMyObject class contains super special data.

Function Documentation

void dt_my_object_delete ( DtMyObject obj)

Destructor for DtMyObject class.

Parameters
objdata object to be destroyed
void* dt_my_object_get ( DtMyObject obj)

Retrieve the data stored in this object.

Parameters
objdata object
Returns
a pointer to the data
DtMyObject* dt_my_object_new ( void *  data)

Constructor for DtMyObject class.

Parameters
dataa pointer to some super special data
Returns
a new data object