JavaDoc

From C3LearningLabs

Always update the javadoc.

The JavaDoc are generated to the folder ...\C3Systems\C3Systems\dist\javadoc.
Example R:\Dev\C3Systems\C3Systems\dist\javadoc

Style Guide

Classes

/**
 * Object that manage system load information<br>
 * Used by manager and players.<br>
 * <br>
 * <b>Copyright 2017 : C2LearningLabs Sweden AB</b>
 * <br>
 * @author  Rego Granlund
 * @version 1.0
 * @time 2017
 * @since 2017
 * @see c3systems.tools.logging.systemLoad.SystemLoadConfigData
 * @see c3systems.tools.logging.systemLoad.SystemLoadComputerData
 * @see c3systems.tools.logging.systemLoad.ui.SystemLoadPanel
 * 
 * @ToDo Move all loging data to the LoggingData class.
 * @ToDo Write parse LoggingData error.
 */
public class SystemLoadComputerData implements c3systems.tools.logging.LoggingDataInterface {


Methods

/**
 * Sets the tool tip text.
 *
 * @param 
 * @return 
 * @throws, @exception are synonyms
 * @see
 */
public void setToolTipText(String text) {


Point List

 * <ul>
 * <li>The Component to draw on
 * <li>A translation origin for rendering and clipping coordinates
 * <li>The current clip
 * <li>The current color
 * <li>The current font
 * <li>The current logical pixel operation function (XOR or Paint)
 * <li>The current XOR alternation color
 *     (see <a href="#setXORMode">setXORMode</a>)
 * </ul>

Set Method

Avoid
The description below says nothing beyond what you know from reading the method name.
The words "set", "tool", "tip", and "text" are simply repeated in a sentence.

/**
 * Sets the tool tip text.
 *
 * @param text  the text of the tool tip
 */
public void setToolTipText(String text) {

Preferred
This description more completely defines what a tool tip is,
in the larger context of registering and being displayed in response to the cursor.

/**
 * Registers the text to display in a tool tip.   The text 
 * displays when the cursor lingers over the component.
 *
 * @param text  the string to display.  If the text is null, 
 *              the tool tip is turned off for this component.
 */
public void setToolTipText(String text) {


View JavaDoc

In a browser open: ...\C3Systems\C3Systems\dist\javadoc\index.html

file:///R:/Dev/C3Systems/C3Systems/dist/javadoc/index.html


View doc for one method

A quick a method for viewing the documentation for one specific method is to open the javadoc panel.

The javadoc panel is opend by in Netbeans menu select: Window->IDE Tools->Javadoc Documentation.

Dev-javadoc-view-method-open.png

When a method is selected in the editor or medhod selector, the javadoc panel will show the javadoc for that method.

Dev-javadoc-view-method.png



Create

Auto Update a Java file

To auto update a java file with standard JavaDoc information do:

Select a package or file in the Files structure selector.

Dev-javadoc-create-fix-1.png

Press <mouse right button> and select Tools->Analyze Javadoc.

Dev-javadoc-create-fix-2.png

Now the analyser is opend.
Check the files you want to auto update.
Tryck "Fix Selected".

Dev-javadoc-create-fix-3.png

Generate All Java doc

To auto generate JavaDoc html files for whole system do:

Select C3Systems or file in the Projects selector.

Dev-javadoc-create-fix-1.png


Analyze