[richfaces-issues] [JBoss JIRA] Commented: (RF-8227) VDL documentation for components/behaviors

[Jay Balunas (JIRA)]

    [ https://issues.jboss.org/browse/RF-8227?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12583617#comment-12583617 ] 

Jay Balunas commented on RF-8227:
---------------------------------

In order to reduce risk for CR1, and Final we need to break this down in to it's different parts.

Tasks ( as I understand them at this time ):
* Component templates, renderers, etc.. need to have the attribute descriptions added
** This is could effect of large # of files, but should be fairly low risk
** Are all mechanisms in place for this now?  Just the work to enter the info is needed?
* CDK Updates to correctly process these descriptions
** Not sure of details here - what is needed?
** Some information is already getting to faces-config, and tag lib files
* CDK or other tool to generate the docs
** Does CDK need to do the actual doc gen, or just the taglib, faces-config?
** Third party doc generators exist, but hard to fine
*** http://taglibrarydoc.dev.java.net/
**** Not accessible any more?
*** Others?

Options:
- Do all work for this in a separate branch, and release VDL docs as possible without effecting Final.
- Do a minimum of changes in 4.0.X and publish what we can
- Do nothing in 4.0.X, and only work on in 4.Next

> VDL documentation for components/behaviors
> ------------------------------------------
>
>                 Key: RF-8227
>                 URL: https://issues.jboss.org/browse/RF-8227
>             Project: RichFaces
>          Issue Type: Task
>      Security Level: Public(Everyone can see) 
>          Components: cdk, component, doc
>    Affects Versions: 4.0.0.ALPHA1
>            Reporter: Nick Belaevski
>            Assignee: Alexander Smirnov
>            Priority: Critical
>
> While IDE support for 4.0.x is pending, we need to ship VDL documentation for reference in RF distribution.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira