Java-Gaming.org Hi !
Featured games (90)
games approved by the League of Dukes
Games in Showcase (701)
Games in Android Showcase (203)
games submitted by our members
Games in WIP (774)
games currently in development
News: Read the Java Gaming Resources, or peek at the official Java tutorials
 
    Home     Help   Search   Login   Register   
Pages: [1]
  ignore  |  Print  
  [Odejava] new javadoc tag  (Read 1334 times)
0 Members and 1 Guest are viewing this topic.
Offline William Denniss

JGO Coder


Projects: 2


Fire at will


« Posted 2004-04-20 05:06:58 »

Guess what?  In light of the ODE focus of Odejava (that is maintain a tight binding to the underlying API - not trying to work around limitations etc...)  I have added a new tag to the ant javadoc task and created a taglet in java code.

The tag is @ode.  Odejava API developers such as Jani and I can use it to inform the users though the javadoc which ODE methods are used and why.

This is important because as I discovered - there are some oddities of ODE that can cause strange bugs.  At least this way you can basically work out what ODE methods are being called for debugging.

It also means you can quickly lookup the ODE docs to check what the function does if it isn't clear.  So basically it can remove some assumptions and guesswork for the user.

A further step when I add log4j logging to Odejava would be to actually log every single call to ODE, again for debugging (only if turned on however...).

An example can be seen on this method:
http://odejava.org/javadoc/org/odejava/Geom.html#removeFromSpace()

cvs log:
1  
2  
3  
4  
5  
6  
7  
8  
9  
10  
11  
12  
13  
 added new @ode tag to the javadoc task.

The tag can be used to document which ODE methods are called and why.

For example:  

The method Body.delete calls  Ode.dBodyDestroy(bodyId);  So in it's javadoc comment, you would add the line:

@ode dBodyDestroy destroys the body

The comment that you add describes the USE of the ODE method - NOT the  function of that method (as people should look up the docs for this).  

Please use this tag :)


Cheers,

Will.

Pages: [1]
  ignore  |  Print  
 
 
You cannot reply to this message, because it is very, very old.

 
ral0r2 (202 views)
2016-11-23 16:08:26

ClaasJG (343 views)
2016-11-10 17:36:32

CoffeeChemist (436 views)
2016-11-05 00:46:53

jay4842 (487 views)
2016-11-01 19:04:52

theagentd (498 views)
2016-10-24 17:51:53

theagentd (486 views)
2016-10-24 17:50:08

theagentd (444 views)
2016-10-24 17:43:15

CommanderKeith (442 views)
2016-10-22 15:22:05

Roquen (415 views)
2016-10-22 01:57:43

Roquen (305 views)
2016-10-17 12:09:13
List of Learning Resources
by elect
2016-09-09 09:47:55

List of Learning Resources
by elect
2016-09-08 09:47:20

List of Learning Resources
by elect
2016-09-08 09:46:51

List of Learning Resources
by elect
2016-09-08 09:46:27

List of Learning Resources
by elect
2016-09-08 09:45:41

List of Learning Resources
by elect
2016-09-08 08:39:20

List of Learning Resources
by elect
2016-09-08 08:38:19

Rendering resources
by Roquen
2016-08-08 05:55:21
java-gaming.org is not responsible for the content posted by its members, including references to external websites, and other references that may or may not have a relation with our primarily gaming and game production oriented community. inquiries and complaints can be sent via email to the info‑account of the company managing the website of java‑gaming.org
Powered by MySQL Powered by PHP Powered by SMF 1.1.18 | SMF © 2013, Simple Machines | Managed by Enhanced Four Valid XHTML 1.0! Valid CSS!