Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Related Pages

Skel - A Skeleton Module


Detailed Description

Author:
your name
Date:
date of birth
Demonstration of the current coding style and blueprint for new modules.

This module demonstrates how a module for the CDG typically looks like. In addition it serves as a rough demonstration of some of the doxygen capabilities. See skel.h and skel.c for the sources of this documentation.

Note, that most of the documentation of a module should be placed into its implementations file (e.g. skel.c) and only the documentation of exported data structures (e.g. MyExportedType) and exported macros are left in the declatrations file (e.g. skel.h). So avoid rendundant documentation of functions and stuff in both places.


Data Structures

struct  MyExportedTypeStruct
struct  MyPrivateTypeStruct

Defines

#define SOMEMACRO

Typedefs

typedef MyExportedTypeStructMyExportedType
typedef MyPrivateTypeStructMyPrivateType

Functions

int myExportedFunction (int a, int b)
int myPrivateFunction (int a, int b)

Variables

int MyExportedTypeStruct::memberA
int MyExportedTypeStruct::memberB
int myExportedVariable
int myExportedVariable
int myPrivateVariable


Define Documentation

#define SOMEMACRO
 

short description Definition at line 28 of file skel.h.


Typedef Documentation

typedef MyExportedTypeStruct* MyExportedType
 

type definition Definition at line 40 of file skel.h.

typedef MyPrivateTypeStruct* MyPrivateType
 

type definition Definition at line 52 of file skel.c.


Function Documentation

int myExportedFunction int  a,
int  b
 

short description. long description

Parameters:
a comments on a
b comments on b
Returns:
the result
Definition at line 86 of file skel.c.

References myExportedVariable.

int myPrivateFunction int  a,
int  b
[inline, static]
 

short description. long description

Parameters:
a comments on a
b comments on b
Returns:
the result
Definition at line 74 of file skel.c.

References myPrivateVariable.


Variable Documentation

MyExportedTypeStruct::memberA [inherited]
 

short description. long description.

MyExportedTypeStruct::memberB [inherited]
 

short description. long description.

int myExportedVariable
 

short description. long description Definition at line 57 of file skel.c.

Referenced by myExportedFunction().

int myExportedVariable
 

short description. long description Definition at line 57 of file skel.c.

Referenced by myExportedFunction().

int myPrivateVariable [static]
 

short description. This variable is private to this module Definition at line 60 of file skel.c.

Referenced by myPrivateFunction().


CDG 0.95 (20 Oct 2004)