You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@jspwiki.apache.org by "Harry Metske (JIRA)" <ji...@apache.org> on 2008/07/30 18:33:32 UTC
[jira] Created: (JSPWIKI-325) improve JavaDocs for the plugins,
provide consistent PARAM_names
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.
[jira] Updated: (JSPWIKI-325) improve JavaDocs for the plugins,
provide consistent PARAM_names
Posted by "Janne Jalkanen (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/JSPWIKI-325?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Janne Jalkanen updated JSPWIKI-325:
-----------------------------------
Fix Version/s: 2.8
Tagged for 2.8.
> 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
> Assignee: Harry Metske
> Priority: Minor
> Fix For: 2.8
>
> 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.
[jira] Updated: (JSPWIKI-325) improve JavaDocs for the plugins,
provide consistent PARAM_names
Posted by "Harry Metske (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/JSPWIKI-325?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Harry Metske updated JSPWIKI-325:
---------------------------------
Attachment: JSPWIKI-325.patch
> 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.
[jira] Resolved: (JSPWIKI-325) improve JavaDocs for the plugins,
provide consistent PARAM_names
Posted by "Janne Jalkanen (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/JSPWIKI-325?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Janne Jalkanen resolved JSPWIKI-325.
------------------------------------
Resolution: Fixed
In 2.7.0-alpha-19
> 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
> Assignee: Harry Metske
> Priority: Minor
> Fix For: 2.8
>
> 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.