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.

[PEMapModder]

PHP doc it is called in PHPStorm.

[alejzeis]

It's basically a copy of java doc...

On Tuesday, July 22, 2014, PEMapModder [email protected] wrote:

PHP doc it is called in PHPStorm.

—
Reply to this email directly or view it on GitHub
#10 (comment)
.

[PEMapModder]

I don't think the | thing is copied.

[alejzeis]

Where's that?

On Tuesday, July 22, 2014, PEMapModder [email protected] wrote:

I don't think the | thing is copied.

—
Reply to this email directly or view it on GitHub
#10 (comment)
.

[PEMapModder]

@jython234

/**
 * @param string|Player $player
 * @return string
 */
public function getPlayerFile($player){
    if($player instanceof Player) $player = $player->getName();
    return $this->getDataFolder().strtolower($player).".yml";
}

[swagking47]

@PEMapModder PEMapModder does every player have his own file ?

[alejzeis]

I guess your right, but still those tags and the doc format look like java
doc to me...

On Tuesday, July 22, 2014, swagking47 [email protected] wrote:

PEMapModder does every player have his own file ?

—
Reply to this email directly or view it on GitHub
#10 (comment)
.

[PEMapModder]

@swagking47 just an example.

[caingaroo]

Thee plugin has a problem in the Faction ranks
[Server] 19:33:13 [INFO] Loading DevTools v1.10.0
[Server] 19:33:18 [INFO] Enabling DevTools v1.10.0
[Server] 19:33:18 [INFO] Loading source plugin PocketFactions v2.0.0
[Server] 19:33:18 [INFO] [DevTools] Registered folder plugin loader
[Server] 19:33:18 [INFO] Preparing level "Arena"
[Server] 19:33:18 [INFO] Enabling PocketFactions v2.0.0
[Server] 19:33:18 [NOTICE] ArrayOutOfBoundsException: "Undefined index: permissions" (E_NOTICE) in "/PocketFactions-new/src/pocketfactions/faction/FactionRank" at line 32
[Server] 19:33:18 [INFO] Disabling PocketFactions v2.0.0
[Server] 19:33:19 [INFO] Starting GS4 status listener
[Server] 19:33:19 [INFO] Setting query port to 19132
[Server] 19:33:19 [INFO] Query running on 0.0.0.0:19132
[Server] 19:33:19 [INFO] Default game type: SURVIVAL
[Server] 19:33:19 [INFO] Done (13.005s)! For help, type "help" or "?"

[PEMapModder]

@caingaroo plugin is not finished yet.

[caingaroo]

@PEMapModders why didnt you labble it on the plugin , or did i miss it somehoe 😯😯

[PEMapModder]

If the plugin is completed, we would make a release.
Where do you think we would label it?

[caingaroo]

Dont know, but could you notify me win the plugin is finished

[alejzeis]

Ehh doxygen.

[PEMapModder]

We will create a release when a beta is ready, and submit on forums when initial release is ready.

[PEMapModder]

@jython234 you don't need to compile it. It can load source plugin.

[PEMapModder]

@astersx how are they related?

[iksaku]

They are not related at all..

[PEMapModder]

@astersx

1. It is supposed to support as many economy plugins as possible, although @onebone's economys and @LegendOfMCPE's xEcon (W.I.P.) will have priority.
2. If CustomRanks overrides other plugins' tags, it has a problem. Don't use it.
3. Why do you even use Economys Land with Factions? That's unreasonable.
4. DIsable commands? Just revoke the permissions with a permissions plugin.
5. If you need to avoid making multiple accounts, maybe you should use an auth plugin that checks that, e.g. ServerAuth by EvolSoft.

[PEMapModder]

What is this? https://github.com/EvolSoft/ServerAuth/blob/master/ServerAuth/resources/config.yml#L30

Also, please don't use the issue tracker as a chatroom. Get on our IRC channel or Gitter chatroom if you need further support.