[TRINIDAD-953] Support for Code Examples in Trinidad Components, Validators, and Converters tagdocs

• Type: New Feature
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.2.6-plugins
• Fix Version/s: 1.2.7-plugins
• Component/s: Plugins
• Assignee: Matthias Wessendorf
• Reporter: Gary Kind
• Created: 14/Feb/08 23:13
• Updated: 27/Jan/10 08:45
• Resolved: 18/Feb/08 14:00

Description

Tag docs generated by the maven-faces-plugin and maven-tagdoc-plugin did not include the ability to easily have code usage examples. With the changes I have made this is now easily done. For example (pardon the pun), in a component xml file:

<faces-config>
<component>
...
<component-extension>
<mfp:long-description>
...
</mfp:long-description>
<mfp:example>
<mfp:source-description>This example shows how to use ....</mfp:source-description>
<mfp:source-code>
<![CDATA[
<tr:form>
<tr:inputText id="test" label="myLabel/>
...
</tr:form>
]]>
</mfp:source-code>
</mfp:example>