improve JavaDocs for the plugins, provide consistent PARAM_names
----------------------------------------------------------------
Key: JSPWIKI-325
URL: https://issues.apache.org/jira/browse/JSPWIKI-325
Project: JSPWiki
Issue Type: Improvement
Components: Plugins
Affects Versions: 2.7.x
Environment: NA
Reporter: Harry Metske
Priority: Minor
Attachments: JSPWIKI-325.patch
As discussed on the jspwiki-dev mailing list......
Currently not all plugins have consistent parameter names, they should be
PARAM_parmxx.
Also the documentation for the core plugins in the source is not as good as it
could be.
Attached a patch that has the following :
- inline (class) documentation for all plugin parameters (gathered as best as I
could from several sources including www.jspwiki.org) have been added, or
changed so that the look and feel is consistent
- all public static variables have been doc'ed (with @value tags), so all these
parameters will show up in the Field summary after running javadoc
- BugReportHandler had inconsistent parm names, so I added PARAM_ in front of
them (this may break your code, not the core jspwiki code though)
==> (do we still need this as a Core Plugin ?! )
- IndexPlugin now extends AbstractReferralPlugin so I could eliminate the
exclude/include parms by inheriting them from AbstratReferralPlugin
- some typo's corrected
Any comments are welcome
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
