[hibernate-issues] [Hibernate-JIRA] Created: (HHH-3370) Document configuration DTD such that DTDDoc can produce documentation for it

[Dave Copeland (JIRA)]

Document configuration DTD such that DTDDoc can produce documentation for it
----------------------------------------------------------------------------

                 Key: HHH-3370
                 URL: http://opensource.atlassian.com/projects/hibernate/browse/HHH-3370
             Project: Hibernate3
          Issue Type: New Feature
            Reporter: Dave Copeland
            Priority: Minor


The hibernate configuration dtd is not documented, and chasing down what the options mean in the reference guide is not straightforward (or up to date; check out the second level cache section; it documents something the DTD doesn't allow).

So, by documenting the DTD itself with comments, a tool like DTDDoc can produce very nice and readable documentation.

http://dtddoc.sourceforge.net/

Example Output:

http://dtddoc.sourceforge.net/example/index.html

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://opensource.atlassian.com/projects/hibernate/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira