PHPDoc cleanup #1023

Closed
trustmaster opened this Issue Sep 3, 2012 · 0 comments

1 participant

@trustmaster
Cotonti member

We have a lot of PHPDocs here and there used to generate http://www.cotonti.com/reference/. The following steps would help to improve navigation and readability of these docs:

  • Start all namespaces (packages) with capitals, make namespace names descriptive.
  • Separate namespace per API/module/plugin.
  • Remove @version, @author, @copyright tags and use @license instead to link to the authorship and copyright information: @license https://github.com/Cotonti/Cotonti/blob/master/License.txt
  • Exclude irrelevant files and functions from the index using @ignore.
@trustmaster trustmaster added the minor label Sep 20, 2014
@trustmaster trustmaster self-assigned this Jan 13, 2015
@macik macik referenced this issue Mar 13, 2016
Closed

Preparation to 0.9.19 release #1494

6 of 6 tasks complete
@macik macik added a commit that referenced this issue Jul 12, 2016
@macik macik Fix package names for API reference geneation
used to clean generate http://www.cotonti.com/reference/
See #1023
7b70747
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment