Documentation for each function and MD documentation

[PEMapModder]

Write documentation in the following syntax:

/**
 * Method details and elaboration in HTML
 * @param ParamType $paramName elaboration
 * @return ReturnType elaboration
*/

Do it for every API function (that is supposed that other plugins can use).

[PEMapModder]

Assign yourself as "Assignee" if you want to do this.

[PEMapModder]

@iJoshuaHD is assigned to #10.

[iJoshuaHD]

@PEMapModder sorry but i dont know

/**

• Method details and elaboration in HTML
• @param ParamType $paramName elaboration
• @return ReturnType elaboration
  */

stands for? or it just explains how this function works?

i thought i will be working on Documentation xD

[PEMapModder]

You can just work on the documentation part :)

[iJoshuaHD]

pheww *

[PEMapModder]

Lol there is really someone called @return. Must get a lot of notifications ;)
@param too

[PEMapModder]

It explains what the function is for. Only API functions need this, though, since internal functions don't need to get documented.

[iJoshuaHD]

yea i dont understand how the documentation thingy works xD

[PEMapModder]

Just do the owner guide and player guide then.

Documentation comment is a format. Basically it just explains what the function is for.

[iJoshuaHD]

will do :)

[alejzeis]

Dis is called java doc.