[
https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Rakesh Midha updated GERONIMO-2661:
-----------------------------------
Attachment: (was: jettydoc.patch)
> Make geronimo schema files more human readable
> ----------------------------------------------
>
> Key: GERONIMO-2661
> URL: https://issues.apache.org/jira/browse/GERONIMO-2661
> Project: Geronimo
> Issue Type: Improvement
> Security Level: public(Regular issues)
> Components: documentation
> Affects Versions: 2.0
> Environment: Any
> Reporter: Rakesh Midha
> Assigned To: Rakesh Midha
> Priority: Minor
> Fix For: Wish List
>
> Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch,
> attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch,
> logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch,
> securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch
>
>
> Geronimo schema files are the files which are basically exposed to all the
> user's to follow the guidelines while developing there plan files. These
> schema files should have lot of documentation just like j2ee descriptor's
> schema's. All the fields should be described.
> Schema formatting provides a nice option to do this by specifying
> <xs:annotation>
> <xs:documentation lang="en">documentation for each
> element goes here</xs:documentation>
> </xs:annotation>
> for each and every element in schema files.
> I think this will make it more human readable, i believe that every file
> which is openly exposed to user's should have lot of documentation for
> readbility. What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
