int function

(const DerivedClass& c)

A global function.

Documentation

A global function. As promised, not only classes and members can be documented with DOC++. This is an example for how to document global scope functions. You'll notice that there is no technical difference to documenting member functions. The same applies to variables or macros.

This is how this documentation has been generated:

	/** A global function.
	    As promised, not only classes and members can be documented with DOC++.
	    This is an example for how to document global scope functions.
	    You'll notice that there is no technical difference to documenting
	    member functions. The same applies to variables or macros.

	    @param c reference to input data object
	    @return whatever
	    @author Snoopy
	    @version 3.3.12
	    @see Derived_Class
	 * /

    int	function(const DerivedClass& c);
    

Parameters:

c - reference to input data object

Returns:

whatever

Author:

Snoopy

Version:

3.3.12

See Also:

Derived_Class

Alphabetic index HTML hierarchy of classes or Java