Document function kernel in traits

This commit is contained in:
Daniel Russel 2006-05-03 11:42:03 +00:00
parent f9c24ceede
commit 66229c5d74
1 changed files with 4 additions and 0 deletions

View File

@ -52,6 +52,8 @@ the appropriate dimension as the primitive used in the
\ccNestedType{Kinetic_kernel}{A model of \ccc{Kinetic::Kernel}.}
\ccNestedType{Function_kernel}{A model of \ccc{Kinetic::FunctionKernel}.}
\ccNestedType{Active_points_[123]_table}{A model of
\ccc{Kinetic::ActiveObjectsTable} which holds the relevant kinetic
primitives.}
@ -68,6 +70,8 @@ used by all the kinetic data structures.}
\ccMethod{Kinetic_kernel kinetic_kernel_object();}{Get a new kinetic kernel.}
\ccMethod{Function_kernel function_kernel_object();}{Get a new function kernel.}
\ccMethod{Simulator::Handle simulator_handle();}{Return a pointer to the \ccc{Kinetic::Simulator} which is to be used in the simulation.}
\ccMethod{Active_points_[123]_table::Handle