Is it of value to put phpDocumenter tags into an add-on?
If so, how should @package and @subpackage be used?
For example:
@package modx
@subpackage add-on-name
or
@package add-on-name
@subpackage add-on-name-component
Thanks.
Is there any plan to provide access to the phpDocs at moxcms.com (say, by extracting them from the SVN repository) or will it be the developer’s responsibility to put them up somewhere else?
Quote from: OpenGeek at Nov 07, 2008, 04:30 PM
Quote from: BobRay at Nov 07, 2008, 04:11 PM
Is there any plan to provide access to the phpDocs at moxcms.com (say, by extracting them from the SVN repository) or will it be the developer’s responsibility to put them up somewhere else?
No plan currently, but I’m sure that could be done if we are interested in documenting the reference components in this way. Sure would make it easy to automate deployment of the documentation, and would be a great way to include tutorials for your packages.
I might be inclined to organize these into namespaces for clarity, preferably that match the Jira project codes.
I’m currently working on the phpDocumenter stuff for SPForm. Is there anything I should do (besides splittingred’s suggestion) to make them work with this hypothetical system?
Also, I notice a peppering of "@access private" and "@access protected" in the MODx code in about equal numbers, but I couldn’t deduce the logic behind picking one or the other. I’ve used @access protected on everything but the public functions in SPForm on the assumption that I want everything to show in the docs but also want to make it clear that those functions shouldn’t be called outside the class. Does that make sense?
MODX Staff