javadocs

[sandeepmur]

Hi,

Any suggestions on how I can create javadocs for some methods in my classes ?

Thnx,

 

[sandeepmur]

dont think I explained my problem correctly..

When I instantiate a class and access its methods, I can only view the type of parameter to be sent but not the parameters themselves..

Anyway, I can make the names of the parameters to be sent and not just the type ?

thnx

 

[sedj]

To create javadocs via the "javadoc" command, you must write your comments for methods in a certain way, eg :

/**
*   My comments on this method
*/
public void myMethod() {

}

See the below link for more info :

http://java.sun.com/j2se/javadoc/

--------------------------------------------------
Free Database Connection Pooling Software

http://www.primrose.org.uk

 

[stefanwagner]

And you use '@param PARAMNAME' to describe your parameters.

/**
* Set the current position of the combination.  In order to unlock the
* lock, the position must be set in the correct sequence corresponding
* to the lock's combination.
* @param position String the current position of the combination
*/
public void setPosition(String position)
{
	this.position = position;
};

See:
$JAVA_HOME/docs/tooldocs/javadoc/index.html
for further help

seeking a job as java-programmer in Berlin:

http://home.arcor.de/hirnstrom/bewerbung

 

[sandeepmur]

Nope, nothing appears.. I have the fwg:

/**
* Logs the data
* @param UserID String the userid of the logged in user.
* @param Site String the Site currently being browsed by
* @param Canal String the canal
* @param Acção String
* @param Dados String
*/

public void logData(String UserID, String Site, String Canal, String Accao, String Dados){
}

anything wrong or missing here ?

TIA

 

[sedj]

Please follow our examples ...

Yes there is something wrong - you have a CRLF (new line) between your comment and you method.

--------------------------------------------------
Free Database Connection Pooling Software

http://www.primrose.org.uk