Phara0h/Phi — Issue #1: No Documentation
Author: Phara0h
Created: 2011-10-21 05:04:13+00:00
State: open

We need to keep up on our documentation.

I added blank method and class java doc templates to what I have so far.

ex:

/**
*
* @param perihelion
* @param radius
* @param rotation
* @param tilt
* @param orbital
* @param eccentricity
*/
public SpaceObjectAttrib(float perihelion,float radius,float rotation,float tilt,float orbital,float eccentricity)
{
this.perihelion = perihelion;
meanRadius = radius;
siderealRotation = rotation;
axialTilt = tilt;
orbitalPeriod = orbital;
this.eccentricity = eccentricity;
}

This is how you need to do your comments in your code so it can be parsed by java doc, so we can have happy java documents! :D