[ http://issues.apache.org/jira/browse/GERONIMO-2661?page=comments#action_12459191 ] Rakesh Midha commented on GERONIMO-2661: ----------------------------------------
Thanks for replying Matt. Sure, I will work on it and provide the required comments, I think it is important. I am keeping it in wishlist for now, because it may take some time. For now I am just assigning this JIRA to myself. As soon as I am in some shape I will move it to 2.0. > Make geronimo schema files more human readable > ---------------------------------------------- > > Key: GERONIMO-2661 > URL: http://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 > > > 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. - If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira
