Java-Gaming.org Hi !
Featured games (83)
games approved by the League of Dukes
Games in Showcase (538)
Games in Android Showcase (132)
games submitted by our members
Games in WIP (600)
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  
  Effort to improve the Xith3D API documentation  (Read 1913 times)
0 Members and 1 Guest are viewing this topic.
Offline William Denniss

JGO Coder


Projects: 2


Fire at will


« Posted 2004-07-28 21:52:42 »

The Xith3d javadocs need a lot of work.  As it is a huge task, I'm trying to get an idea of who will be able to help.

How I believe we could do it is if we had say 20 or 30 people who took a couple of .java files each week and fully javadoc'd them.

The goal would be to have complete javadoc's for the whole API (that's all methods, parameters, returns, classes, exceptions, etc. documented) PLUS all unimplemented methods marked as such (perhaps using a custom @unimplemented tag or something).  Thus, once complete we would hopefully be able to program with Xith3d without looking at the source code.

No actual code changes would be accepted as it would be too confusing - although these patches could be submitted separately.

This would be a good chance of giving something back to the Xith3D community while doing something which is of a direct benefit to yourself and others.

Will.

PS.  If you vote "yes", please also reply to this topic so we know who you are Smiley

PPS. This poll is continuing the thoughts raised in this thread

Offline SpuTTer

Senior Devvie


Medals: 1
Exp: 14 years


Lazy Middle Class Intellectual


« Reply #1 - Posted 2004-07-28 22:30:40 »

+1

Sacramento Volleyball
"Whitty phrase goes here."
Offline blahblahblahh

JGO Coder


Medals: 1


http://t-machine.org


« Reply #2 - Posted 2004-07-29 00:13:20 »

I said "yes" but I won't be writing anything.

What I *can* do is review them. This is an essential stage, especially if you're having more than 2 or 3 people writing docs, and even more so if they're not being written by xith3d core authors Smiley.

I do use Xith a bit, but not enough to want to write docs (nor do I have the time to think that much), but enough that I can read someone else's docs and quickly point out which comments aren't good enough and why.

e.g. recognising where a method comment doesn't actually describe the method, but instead just rephrases the words used in the method name Smiley.

malloc will be first against the wall when the revolution comes...
Games published by our own members! Check 'em out!
Legends of Yore - The Casual Retro Roguelike
Offline William Denniss

JGO Coder


Projects: 2


Fire at will


« Reply #3 - Posted 2004-07-29 01:47:36 »

that would be very helpful.  Thanks.

Will.

Offline kevglass

« JGO Spiffy Duke »


Medals: 212
Projects: 24
Exp: 18 years


Coder, Trainee Pixel Artist, Game Reviewer


« Reply #4 - Posted 2004-07-29 05:00:59 »

I'll help out with this (assuming I'm ever gonna get a chance to touch a computer outside work). Would like to see that guideline up front tho.

Kev

Offline MrSquid

Senior Newbie




Java games rock!


« Reply #5 - Posted 2004-07-29 05:36:35 »

+1 also
Offline William Denniss

JGO Coder


Projects: 2


Fire at will


« Reply #6 - Posted 2004-07-30 07:54:23 »

4 people so far (including myself) + 1 to review.

Anyone else want to help out?  It's not a huge amount of work, just documenting a couple of class files when you have the time.

Will.

Offline aschwalb

Senior Newbie




Java games rock!


« Reply #7 - Posted 2004-07-30 11:13:02 »

Hi

Can do a bit.

Bye Adi
Offline JoyrexJ9

Senior Newbie




Losing my mind...


« Reply #8 - Posted 2004-08-22 07:16:29 »

Ok,

Time to do my bit...
I'd be happy to document a few classes

Ben
----------------------------------------------------
Dungeon Engine - http://cgi.bencoleman.plus.com/tiki/tiki-index.php?page=DungeonEngine
Offline Amos Wenger

Senior Devvie




Everything's possible, but not everything's fun...


« Reply #9 - Posted 2004-08-24 10:19:21 »

+1
Maybe yes, if I find the time to do it !

It's sure that the documentation is'nt complete at all !
For exemple : how should I detect collision between two geometry objects ?

"Once you start working on something, don't be afraid of failure and don't abandon it. People who work sincerely are the happiest"
Games published by our own members! Check 'em out!
Legends of Yore - The Casual Retro Roguelike
Offline victorwang

Senior Newbie




i will be uberjavaman


« Reply #10 - Posted 2004-08-24 16:37:47 »

Quote
+1
Maybe yes, if I find the time to do it !

It's sure that the documentation is'nt complete at all !
For exemple : how should I detect collision between two geometry objects ?



Uh yea... I just realized that there is no explicit support of collision detection or avoidance in the "Xith3D Features" thread.. I guess you have to do that yourself?

Okay nevermind, I just looked in the Javadoc and there are a bunch of classes to support collisions -- must have just been left out of the Features thread accidentally.

-=uberjavamantobe=-
Offline William Denniss

JGO Coder


Projects: 2


Fire at will


« Reply #11 - Posted 2004-08-24 21:47:40 »

The collision stuff is not part of the core despite that fact it may appear so.  Xith3D is a scenegraph first and foremost.  Make sure you search the threads here for info on that package some people have reported problems.  You are free to use whatever collision code you like Smiley

Will.

Offline Amos Wenger

Senior Devvie




Everything's possible, but not everything's fun...


« Reply #12 - Posted 2004-08-25 07:09:06 »

So I will use OdeJava for my collision detection.

"Once you start working on something, don't be afraid of failure and don't abandon it. People who work sincerely are the happiest"
Pages: [1]
  ignore  |  Print  
 
 
You cannot reply to this message, because it is very, very old.

 

Add your game by posting it in the WIP section,
or publish it in Showcase.

The first screenshot will be displayed as a thumbnail.

rwatson462 (29 views)
2014-12-15 09:26:44

Mr.CodeIt (20 views)
2014-12-14 19:50:38

BurntPizza (40 views)
2014-12-09 22:41:13

BurntPizza (75 views)
2014-12-08 04:46:31

JscottyBieshaar (37 views)
2014-12-05 12:39:02

SHC (50 views)
2014-12-03 16:27:13

CopyableCougar4 (47 views)
2014-11-29 21:32:03

toopeicgaming1999 (114 views)
2014-11-26 15:22:04

toopeicgaming1999 (102 views)
2014-11-26 15:20:36

toopeicgaming1999 (30 views)
2014-11-26 15:20:08
Resources for WIP games
by kpars
2014-12-18 10:26:14

Understanding relations between setOrigin, setScale and setPosition in libGdx
by mbabuskov
2014-10-09 22:35:00

Definite guide to supporting multiple device resolutions on Android (2014)
by mbabuskov
2014-10-02 22:36:02

List of Learning Resources
by Longor1996
2014-08-16 10:40:00

List of Learning Resources
by SilverTiger
2014-08-05 19:33:27

Resources for WIP games
by CogWheelz
2014-08-01 16:20:17

Resources for WIP games
by CogWheelz
2014-08-01 16:19:50

List of Learning Resources
by SilverTiger
2014-07-31 16:29:50
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!