LegendOfMCPE / PocketFactions

Factions plugin
10 stars 15 forks source link

Documentation for each function and MD documentation #10

Open PEMapModder opened 10 years ago

PEMapModder commented 10 years ago

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 commented 10 years ago

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

PEMapModder commented 10 years ago

@ijoshuahd is assigned to #10.

iJoshuaHD commented 10 years ago

@PEMapModder sorry but i dont know

/**

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

i thought i will be working on Documentation xD

PEMapModder commented 10 years ago

You can just work on the documentation part :)

iJoshuaHD commented 10 years ago

pheww *

PEMapModder commented 10 years ago

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

PEMapModder commented 10 years ago

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

iJoshuaHD commented 10 years ago

yea i dont understand how the documentation thingy works xD

PEMapModder commented 10 years ago

Just do the owner guide and player guide then.

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

iJoshuaHD commented 10 years ago

will do :)

alejzeis commented 10 years ago

Dis is called java doc.

PEMapModder commented 10 years ago

PHP doc it is called in PHPStorm.

alejzeis commented 10 years ago

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

On Tuesday, July 22, 2014, PEMapModder notifications@github.com wrote:

PHP doc it is called in PHPStorm.

— Reply to this email directly or view it on GitHub https://github.com/LegendOfMCPE/PocketFactions/issues/10#issuecomment-49822986 .

PEMapModder commented 10 years ago

I don't think the | thing is copied.

alejzeis commented 10 years ago

Where's that?

On Tuesday, July 22, 2014, PEMapModder notifications@github.com wrote:

I don't think the | thing is copied.

— Reply to this email directly or view it on GitHub https://github.com/LegendOfMCPE/PocketFactions/issues/10#issuecomment-49828260 .

PEMapModder commented 10 years ago

@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 commented 10 years ago

@PEMapModder PEMapModder does every player have his own file ?

alejzeis commented 10 years ago

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

On Tuesday, July 22, 2014, swagking47 notifications@github.com wrote:

PEMapModder does every player have his own file ?

— Reply to this email directly or view it on GitHub https://github.com/LegendOfMCPE/PocketFactions/issues/10#issuecomment-49828693 .

PEMapModder commented 10 years ago

@swagking47 just an example.

caingaroo commented 9 years ago

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 commented 9 years ago

@caingaroo plugin is not finished yet.

caingaroo commented 9 years ago

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

PEMapModder commented 9 years ago

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

caingaroo commented 9 years ago

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

alejzeis commented 9 years ago

Ehh doxygen.

PEMapModder commented 9 years ago

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

PEMapModder commented 9 years ago

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

PEMapModder commented 8 years ago

@astersx how are they related?

iksaku commented 8 years ago

They are not related at all..

PEMapModder commented 8 years ago

@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 commented 8 years ago

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.