doxygen-example  0.0.1
A silly C program to use for demonstrating doxygen
Display

Macros

#define HELLO_WORLD   "Hello world!"
 
#define GOODBYE_WORLD   "Goodbye cruel world"
 

Functions

int displayMessage (char *message)
 A silly function that wraps printf() More...
 

Detailed Description

This provides a silly way to display messages.

Precondition
There are no prerequisites.

Macro Definition Documentation

#define GOODBYE_WORLD   "Goodbye cruel world"

A goodbye world string.

#define HELLO_WORLD   "Hello world!"

A hello world strgin.

Function Documentation

int displayMessage ( char *  message)

A silly function that wraps printf()

This is simply to allow a demonstration of the doxygen markup for documenting functions.

Parameters
messageA string that is to be displayed.
Returns
Always returns EXIT_SUCCESS if completed without error.