Skip to content

Commit

Permalink
Fixed some javadoc warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
tzaeschke committed Sep 1, 2014
1 parent 2b77d06 commit 777fdac
Show file tree
Hide file tree
Showing 8 changed files with 29 additions and 38 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
package org.ode4j.cpp.internal;

import org.ode4j.ode.OdeHelper;
import org.ode4j.ode.internal.OdeInit;


/**
Expand Down Expand Up @@ -103,7 +104,7 @@ public static void dInitODE() {
* @return A nonzero if initialization succeeded and zero otherwise.
*
* @see #dCloseODE()
* @see OdeInit
* @see OdeInit#dInitODE2(int)
*/
//* @see #dInitODEFlags
//ODE_API
Expand Down
1 change: 0 additions & 1 deletion core/src/main/java/org/ode4j/math/DVector3.java
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,6 @@ public final double dot(DVector3View b) {
/**
* Return the 'dot' product of two vectors.
* r = a0*b0 + a1*b1 + a2*b2;
* @param b
* @return (this) * b
*/
public final double dot(double[] da, int pos) {
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/org/ode4j/ode/DWorld.java
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ public interface DWorld {
*
* @see #cleanupWorkingMemory()
* @see #setStepMemoryReservationPolicy(DWorldStepReserveInfo)
* @see #setStepMemoryManager(DWorldStepMemoryFunctionsInfo)
// * @see #setStepMemoryManager(DWorldStepMemoryFunctionsInfo)
*/
boolean useSharedWorkingMemory(DWorld from_world/*=NULL*/);

Expand All @@ -275,7 +275,7 @@ public interface DWorld {
*
* @see #useSharedWorkingMemory(DWorld)
* @see #setStepMemoryReservationPolicy(DWorldStepReserveInfo)
* @see #setStepMemoryManager(DWorldStepMemoryFunctionsInfo)
// * @see #setStepMemoryManager(DWorldStepMemoryFunctionsInfo)
*/
void cleanupWorkingMemory();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ private static vec4f DVector4Tovec4f(DVector4C v) {
// should be patched through to the dDOUBLE version above

//#define gim_trimesh_get_triangle_vertices gim_trimesh_get_triangle_verticesODE
static void gim_trimesh_get_triangle_verticesODE( GimTrimesh mesh ) {
mesh.gim_trimesh_get_triangle_vertices(0, null, null, null);
}
// static void gim_trimesh_get_triangle_verticesODE( GimTrimesh mesh ) {
// mesh.gim_trimesh_get_triangle_vertices(0, null, null, null);
// }

// inline int gim_trimesh_ray_closest_collisionODE( GIM_TRIMESH *mesh, dVector3 origin,
// dVector3 dir, GREAL tmax, GIM_TRIANGLE_RAY_CONTACT_DATA *contact ) {
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/org/ode4j/ode/internal/DxWorld.java
Original file line number Diff line number Diff line change
Expand Up @@ -1358,7 +1358,7 @@ public void setStepThreadingImplementation(
*
* <code>free_block</code> is a function to delete existing memory block.
*
* @see DWorld#setStepMemoryManager(DWorldStepMemoryFunctionsInfo)
// * @see DWorld#setStepMemoryManager(DWorldStepMemoryFunctionsInfo)
* @deprecated Do not use ! (TZ)
*/
public static class DWorldStepMemoryFunctionsInfo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,9 @@ public abstract class DThreadingImplementation {
* Do not use this function with self-made custom implementations -
* they should be bundled with their own set of functions.
*
* @param impl Threading implementation ID
* @return Pointer to associated functions structure
*
* @see dThreadingAllocateMultiThreadedImplementation
* @see DxThreadingImplementation#dThreadingAllocateMultiThreadedImplementation
*/
public abstract DThreadingFunctionsInfo dThreadingImplementationGetFunctions();

Expand All @@ -87,8 +86,8 @@ public abstract class DThreadingImplementation {
* If this function is called for self-threaded built-in threading implementation
* the call has no effect.
*
* @see dThreadingAllocateMultiThreadedImplementation
* @see dThreadingImplementationCleanupForRestart
* @see DxThreadingImplementation#dThreadingAllocateMultiThreadedImplementation
* @see #dThreadingImplementationCleanupForRestart
*/
public void shutdownProcessing() {
dThreadingImplementationShutdownProcessing();
Expand All @@ -106,10 +105,8 @@ public void shutdownProcessing() {
* If this function is called for self-threaded built-in threading implementation
* the call has no effect.
*
* @param impl Threading implementation ID
*
* @see dThreadingAllocateMultiThreadedImplementation
* @see dThreadingImplementationShutdownProcessing
* @see DxThreadingImplementation#dThreadingAllocateMultiThreadedImplementation
* @see #shutdownProcessing()
*/
public abstract void dThreadingImplementationCleanupForRestart();

Expand All @@ -120,7 +117,7 @@ public void shutdownProcessing() {
* from all the objects it was assigned to and that there are no more threads
* serving it before attempting to call this function.
*
* @see dThreadingAllocateMultiThreadedImplementation
* @see DxThreadingImplementation#dThreadingAllocateMultiThreadedImplementation
*/
public abstract void free();
//public abstract void dThreadingFreeImplementation();
Expand All @@ -146,12 +143,11 @@ public interface DThreadReadyToServeCallback {
* be used until all dedicated threads register within it as otherwise it will not
* have accurate view of the execution resources available.
*
* @param impl Threading implementation ID
* @param readiness_callback Optional readiness callback to be called after thread enters the implementation
* @param callback_context A value to be passed as parameter to readiness callback
*
* @see dThreadingAllocateMultiThreadedImplementation
* @see dThreadingImplementationShutdownProcessing
* @see DxThreadingImplementation#dThreadingAllocateMultiThreadedImplementation
* @see #shutdownProcessing()
*/
public abstract void dExternalThreadingServeMultiThreadedImplementation(
DThreadReadyToServeCallback readiness_callback/*=NULL*/, CallContext callback_context/*=NULL*/);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ public abstract class DThreadingThreadPool {
* @param ode_data_allocate_flags Flags to be passed to @c dAllocateODEDataForThread on behalf of each thread
* @return ID of object allocated or NULL on failure
*
* @see dThreadingAllocateMultiThreadedImplementation
* @see dThreadingImplementationShutdownProcessing
* @see dThreadingFreeThreadPool
* @see DxThreadingImplementation#dThreadingAllocateMultiThreadedImplementation
* @see DThreadingImplementation#shutdownProcessing()
* @see #freeThreadPool()
*/
public static DThreadingThreadPool allocateThreadPool(int thread_count,
int stack_size, int ode_data_allocate_flags, Object[][] reserved/*=NULL*/) {
Expand All @@ -73,12 +73,11 @@ public static DThreadingThreadPool allocateThreadPool(int thread_count,
* This function waits for threads to register within implementation before returning.
* So, after the function call exits the implementation can be used immediately.
*
* @param pool Thread pool ID to serve the implementation
* @param impl Implementation ID of implementation to be served
*
* @see dThreadingAllocateThreadPool
* @see dThreadingAllocateMultiThreadedImplementation
* @see dThreadingImplementationShutdownProcessing
* @see #allocateThreadPool(int, int, int, Object[][])
* @see DxThreadingImplementation#dThreadingAllocateMultiThreadedImplementation
* @see DThreadingImplementation#shutdownProcessing()
*/
public abstract void serveMultiThreadedImplementation(DThreadingImplementation impl);

Expand All @@ -97,11 +96,9 @@ public static DThreadingThreadPool allocateThreadPool(int thread_count,
* It is OK to call this function even if pool was not serving any threading implementation
* in which case the call exits immediately with minimal delay.
*
* @param pool Thread pool ID to wait for
*
* @see dThreadingAllocateThreadPool
* @see dThreadingImplementationShutdownProcessing
* @see dThreadingFreeThreadPool
* @see #allocateThreadPool(int, int, int, Object[][])
* @see DThreadingImplementation#shutdownProcessing()
* @see #freeThreadPool()
*/
public abstract void waitIdleState();

Expand All @@ -112,10 +109,8 @@ public static DThreadingThreadPool allocateThreadPool(int thread_count,
* before this function is called. Otherwise the call is going to block
* and wait until pool's threads return.
*
* @param pool Thread pool ID to delete
*
* @see dThreadingAllocateThreadPool
* @see dThreadingImplementationShutdownProcessing
* @see #allocateThreadPool(int, int, int, Object[][])
* @see DThreadingImplementation#shutdownProcessing()
*/
public abstract void freeThreadPool();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ public abstract class DxThreadingImplementation extends DThreadingImplementation
*
* @return ID of object allocated or NULL on failure
*
* @see DThreadingImplementation#allocateMultiThreadedImplementation()
* @see DThreadingImplementation#freeImplementation()
* @see DxThreadingImplementation#dThreadingAllocateMultiThreadedImplementation()
* @see DThreadingImplementation#free()
*/
/*ODE_API */
// public static DThreadingImplementation dThreadingAllocateSelfThreadedImplementation() {
Expand Down

0 comments on commit 777fdac

Please sign in to comment.