Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCU-7

A new paragraph type to include javadoc and code samples

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • Major
    • None
    • None
    • None
    • None

    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)

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                gjoseph Magnolia International
                gjoseph Magnolia International
                Votes:
                0 Vote for this issue
                Watchers:
                0 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Bug DoR