ExampleData API

Description
This is a bona fide javadoc style comment. The first sentance is a description, and the correct tags are provided.
Author: Dave Deaven
Version: $Id: Example.h,v 1.47 2004/01/03 22:15:12 deaven Exp $
See also:
Heritage
    examples.ExampleData
Complete known class diagram
Header file

#include <sys/types.h> // the header tag is a cxxwrap extension
#include <examples/Example.h>


Public Method and Attribute summary
ExampleData(x)
        Make a new number.
ExampleData(x)
        test a bug for unsigned and regular integral in ctors
ExampleData(x)
~ExampleData()
int number()
        Access the number.
void number(x)
        Set the number $param x the number to set
int twiceNumber()
        Access twice the number.
int value
        attributes can also be commented, this is the value
Enumerations
enum MyEnumeration
Values:
ONE
uno
TWO
dos
THREE
tres
FOUR
quatro
SYMBOL
asi asi
Constructors
ExampleData(int x = 0)
Make a new number.
Parameters:
x - the number to make
ExampleData(long x)
test a bug for unsigned and regular integral in ctors
ExampleData(unsigned long x)
~ ExampleData()
Public Methods and Attributes
int number()
Access the number.
Returns:
the number
void number(int x)
Set the number $param x the number to set
int twiceNumber()
DEPRECATED: since multiplication was added to the C language
Access twice the number. This second is not part of this comment's summary sentance.
Returns:
2 * N, where N is the number
int value
attributes can also be commented, this is the value
Protected Methods and Attributes
int Pnumber()