Uploaded image for project: 'TomEE'
  1. TomEE
  2. TOMEE-2341 TomEE Site Generator
  3. TOMEE-2346

Generate Javadoc '@see' references to our examples and docs

    XMLWordPrintableJSON

Details

    • Sub-task
    • Status: Resolved
    • Major
    • Resolution: Auto Closed
    • None
    • None
    • Website
    • None

    Description

      We could link the javadoc to actual documents that reference that particular class.

      Imagine that we index all the examples by what classes they use, including api classes.  We grab a copy of the source for all those classes and add a bunch of `@see` elements to the source code to reference the page that will be generated.

      The resulting javadoc would then have links to examples that better show how that annotation or class can work.

       

      Incredibly cool idea.

       

      Origin of the idea is we used

      Attachments

        Activity

          People

            Unassigned Unassigned
            dblevins David Blevins
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: