geronimo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Christopher M. Cardona (JIRA)" <>
Subject [jira] Commented: (GERONIMO-2661) Make geronimo schema files more human readable
Date Sun, 25 Feb 2007 06:34:05 GMT


Christopher M. Cardona commented on GERONIMO-2661:

Applied the alldoc.patch to trunk rev. 511458 with additional modifications: 

- Removed the extra Apache license annotation (I think the original Apache license header
is enough)
- Arranged the schema formatting
- Changed some annotation/documentation text

Thanks Rakesh!

> Make geronimo schema files more human readable
> ----------------------------------------------
>                 Key: GERONIMO-2661
>                 URL:
>             Project: Geronimo
>          Issue Type: Improvement
>      Security Level: public(Regular issues) 
>          Components: documentation
>    Affects Versions: 2.0
>         Environment: Any
>            Reporter: Rakesh Midha
>         Assigned To: Christopher M. Cardona
>            Priority: Minor
>             Fix For: 2.0
>         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,
> 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.

View raw message