examples.Example
    |
    +---examples.DerivedExample

typedef unsigned long my_protected_size_t

a protected typedef

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

typedef my_size_t* my_size_t_ptr

this is a recursive typedef

typedef unsigned long my_size_t

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

enum SecondEnumeration

Values:

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

enum KnownNumber

This is the definition of an enumerated type.

Values:

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

int blah(int x)


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


double doubleField


A public member field containing a primitive type

ExampleData* exampleDataPtr


A public member field containing an object pointer

ExampleData exampleData


A public member field containing an object instance

void indy_int(int*** threestar)


void indy_object(Example** twostar)


proper documenting of multiple indirection levels

void test32(int* i)


void test64(long* l)


test 32/64 bit int sizes

void stringarrayfunc(char** a)


test string arrays

Example* nullTest(Example* in)


test NULL across JNI

void callCallback()


void setCallback(Callback* x)


void ti(DerivedParameterized<int> & dp)


template instantiation woes illustrated by these.

int opCast()


void op+=(const Example& other)


Example& op=(const Example& other)


void how_big_ptr(unsigned long* so_big)


void how_big(unsigned long so_big)


this function uses the local type definition

Example* clone()


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

double h(Example::KnownNumber n)


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


void other_arrays(int* x)


void explicit_arrays(int* x)


plain jane C comment on one line follows slash-slash

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.

ACE::Interior::Nest badPractice()


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

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


this method tests an argument formatting bug

char* str(char* s)


this comment has stars at the beginning of each line.

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


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

anon3 AnonEnumeratedVariable


this tests a bug

void unknownClassPointerArray(UnknownClass** array)


this should not get JNI wrapped

int bar()


multiple comment styles are recognized

int testDefaults2(char* x = 0)


int testDefaults(int x = -1)


const char* foo4(const char* s)


const char* foo3(const char* s)


int foo2(int* x,
         int len)


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 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.

Callback* cb


ExampleData num


void how_big_protected(unsigned long so_big)