[MAGNOLIA-2491] Generate content2bean documentation Created: 03/Dec/08 Updated: 04/Nov/15 Resolved: 04/Nov/15 |
|
| Status: | Closed |
| Project: | Magnolia |
| Component/s: | build |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | New Feature | Priority: | Major |
| Reporter: | Magnolia International | Assignee: | Unassigned |
| Resolution: | Won't Do | Votes: | 2 |
| Labels: | None | ||
| Σ Remaining Estimate: | Not Specified | Remaining Estimate: | Not Specified |
| Σ Time Spent: | Not Specified | Time Spent: | Not Specified |
| Σ Original Estimate: | Not Specified | Original Estimate: | Not Specified |
| Attachments: |
|
|||||||||||||||||||||||||||||||||||
| Issue Links: |
|
|||||||||||||||||||||||||||||||||||
| Sub-Tasks: |
|
|||||||||||||||||||||||||||||||||||
| Template: |
|
|||||||||||||||||||||||||||||||||||
| Acceptance criteria: |
Empty
|
|||||||||||||||||||||||||||||||||||
| Date of First Response: | ||||||||||||||||||||||||||||||||||||
| Description |
|
To simplify documentation, we should generate documentation for all beans/components which can be configured through content2bean. Simpler and more end-user focused than javadoc. An XDoclet2 plugin seems a simple and reasonable approach for achieving this. |
| Comments |
| Comment by Magnolia International [ 26/Mar/09 ] |
|
Here's the pom configuration snippet to generated c2b doc. |
| Comment by Magnolia International [ 30/Mar/09 ] |
|
Check out http://svn.magnolia-cms.com/svn/build/content2bean-xdoclet-plugin/trunk/c2b-docgen.xml and try ant -f /path/to/c2b-docgen.xml ! |
| Comment by Michael Mühlebach [ 04/Nov/15 ] |
|
Given the thousands of other issues we have open that are more highly requested, we won't be able to address this issue in the foreseeable future. Instead we will focus on issues with a higher impact, and more votes. |