[DOCU-7] A new paragraph type to include javadoc and code samples Created: 01/Feb/07  Updated: 07/Apr/10  Resolved: 07/Apr/10

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Bug Priority: Major
Reporter: Magnolia International Assignee: Magnolia International
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
duplicate
duplicates MGNLSNIPPET-1 Ability to render code (or other) sni... Closed
relation
is related to MGNLWIKI-27 Snippet Macro Closed
Template:
Acceptance criteria:
Empty
Bug DoR:
[ ]* Steps to reproduce, expected, and actual results filled
[ ]* Affected version filled

 Description   

Taking the idea of the "snippet" plugin that's been contributed to confluence a bit further, we could have a special paragraph type that would allow displaying some code or javadoc content. It could take, as parameter, a URL to an svn view page, an identifier and "type"
We would then scrape the URL content, stuff it in qdox (http://qdox.codehaus.org) and based on the given identifier and type we would output the desired content. Identifiers could be method names, but we will probably need to go slightly further to support methods with the same name but different signatures, and inner classes. Types could be "code" or "javadoc" and could be refined further to say what portions of the javadoc we care about for instance (we most likely won't care about the @throws tags, but could care about the @see tags ?)

The reason to do this: easy writing of technical documentation and inherent synchronism between the source code, code samples, javadoc and magnolia-based documentation. (and YES, one of the ideas would be to use this to document magnolia of course)



 Comments   
Comment by Magnolia International [ 07/Apr/10 ]

see MGNLSNIPPET-1 and MGNLWIKI-27

Generated at Mon Feb 12 01:05:01 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.