[
https://issues.jboss.org/browse/RFPL-2978?page=com.atlassian.jira.plugin....
]
Brian Leathem commented on RFPL-2978:
-------------------------------------
An alternative is to pull in the VDL details of the RF docs from the generated docs. This
could be done by including the VDL doc in our distributed docs as an appendix for
example.
Push VDL details out of Component Reference
--------------------------------------------
Key: RFPL-2978
URL:
https://issues.jboss.org/browse/RFPL-2978
Project: RichFaces Planning
Issue Type: Task
Security Level: Public(Everyone can see)
Components: doc
Affects Versions: 5.0.0.Alpha1
Reporter: Lukáš Fryč
See [Forum Reference].
----
I have noticed each of the components in Component Reference contains referecen data:
{code}
3.5.2. Reference data
component-type: org.richfaces.CommandLink
component-class: org.richfaces.component.UICommandLink
component-family: javax.faces.Command
renderer-type: org.richfaces.CommandLinkRenderer
{code}
Similarly, VDL doc contains same information:
{code}
Tag Information
Component type org.richfaces.CommandLink
Tag Name a4j:commandLink
Renderer Type org.richfaces.CommandLinkRenderer
Handler Class None
{code}
The advantage of VDL doc is that it is automatically generated and so it doesn't need
to be updated manually everytime something is changed.
On the other hand, those are also not information which are used regularly - they are
intented for advanced users and use cases.
Thus I suggest to remove the Reference Data from Components Reference.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see:
http://www.atlassian.com/software/jira