[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: |
|
||||||||||||||||
| 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" 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 |