This project is read-only.

Description Attribute

The description attribute provides the ability the user to define a custom message that will be presented on the top level documentation page for each schema documented.

Examples:
<schemaSpy
    jarPath="..."
    dbType="..."
    host="..."
    port="..."
    dbName="..."
    description="This is my custom description."
    ... />


Notes:
  • If markup is provided (i.e. <a ...>) in the description, the string will need to be encoded. Basic &gt; or &lt; entities will properly tranisition the markup; however, the equal (=) sign must be escaped with a backslash (\) prior to it.
  • There is a known issue with the description feature with SchemaSpy version 4.1.1. The escaping of the equal sign is not setup properly. This bug has been raised to the SchemaSpy maintainers through http://sourceforge.net/tracker/?func=detail&aid=2433403&group_id=137197&atid=737987. A patch has been created and should be fully fixed at the next release.

Last edited Jun 17, 2009 at 12:41 AM by JamesEggers, version 1

Comments

No comments yet.