[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: Text File MAGNOLIA-2491.txt    
Issue Links:
relation
is related to MAGNOLIA-1211 Generate TLD files Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
MAGNOLIA-2676 c2bdoc: links to javadoc Sub-task Closed Magnolia International  
MAGNOLIA-2678 c2bdoc: links to appropriate transformer Sub-task Closed Magnolia International  
MAGNOLIA-2679 c2bdoc: navigation by path Sub-task Closed Magnolia International  
MAGNOLIA-2680 c2bdoc: stylesheet Sub-task Closed Magnolia International  
MAGNOLIA-2681 c2bdoc: generate and display path for... Sub-task Closed Magnolia International  
MAGNOLIA-2682 c2bdoc: indicate superclasses Sub-task Closed Magnolia International  
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.
It currently can't work because we already configure the xdoclet plugin to generate TLDs.
(and as such, it would also generate TLDs for core, for instance)

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.
Thanks for taking the time to raise this issue. As you are no doubt aware this issue has been on our backlog for some time now with very little movement.
I'm going to close this to set expectations so the issue doesn't stay open for years with few updates. If the issue is still relevant please feel free to reopen it or create a new issue.

Generated at Mon Feb 12 03:37:14 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.