examples.Example

typedef unsigned long my_size_t

This is a type definition local to this class, which can be documented here.

typedef my_size_t* my_size_t_ptr

this is a recursive typedef

typedef void (*)(int,ExampleData*,void*) callback_func

typedef unsigned long my_protected_size_t

a protected typedef

enum KnownNumber

This is the definition of an enumerated type.

Values:

ZERO	This is an embedded enumeration comment.
ONE
TWO
THREE
FOUR

enum SecondEnumeration

Values:

BOBO	different style of comments in this one
RINGO	checking a bug

Example()


Example(const ExampleData& init,
         int temp1)


in general, any html tags with matching start and end tags are recognized.

Example(const ExampleData* init)


Helen asked me to make links work, too. but she probably wants ExampleData style links.

Parameters: init - and booboo a link to booboo() embedded

~ Example()


int booboo()


if you use strict C type checking for no args, we'll remove the "void" spec. Also note that this comment is done with double slashes ("//") at the beginning of each line.

int foo(int x = 0,
        double y = 0,
        double z = -1)


A simple function

Parameters: x - the first argument y - the second argument z - the third argument Returns: a status

int foo2(int* x,
         int len)


const char* foo3(const char* s)


const char* foo4(const char* s)


int testDefaults(int x = -1)


int testDefaults2(char* x = 0)


int bar()


multiple comment styles are recognized

void unknownClassPointerArray(UnknownClass** array)


this should not get JNI wrapped

anon3 AnonEnumeratedVariable


this tests a bug

void fun(int x,
         float f,
         double g,
         unsigned int i,
         long l)


this is fun. there should be two lines in this comment.

char* str(char* s)


this comment has stars at the beginning of each line.

static int getter(int x,
                  int y,
                  int z,
                  const char* q)


this method tests an argument formatting bug

ACE::Interior::Nest badPractice()


C++ namespaces, some like them, I don't

void pointers(int* x,
              long* y,
              float* f,
              double* g)


This comment is loaded with stars, including a passel of 'em on the first line. The next line has'em too.

void explicit_arrays(int* x)


plain jane C comment on one line follows slash-slash

void other_arrays(int* x)


void string_arrays(const char** files,
                   int len)


double h(Example::KnownNumber n)


Example* clone()


java defines these methods, so they must be aliased in wrappers.

void how_big(unsigned long so_big)


this function uses the local type definition

void how_big_ptr(unsigned long* so_big)


Example& op=(const Example& other)


void op+=(const Example& other)


int opCast()


void ti(DerivedParameterized<int> & dp)


template instantiation woes illustrated by these.

void setCallback(Callback* x)


void callCallback()


Example* nullTest(Example* in)


test NULL across JNI

void stringarrayfunc(char** a)


test string arrays

void test64(long* l)


test 32/64 bit int sizes

void test32(int* i)


void indy_object(Example** twostar)


proper documenting of multiple indirection levels

void indy_int(int*** threestar)


ExampleData exampleData


A public member field containing an object instance

ExampleData* exampleDataPtr


A public member field containing an object pointer

double doubleField


A public member field containing a primitive type

void registerCallback(void* __cbd,
                      void (*)(int,ExampleData*,void*) cbfunc)


void how_big_protected(unsigned long so_big)


ExampleData num


Callback* cb