Tapestry
  1. Tapestry
  2. TAPESTRY-2076

Component report should break out as one class per page and include examples

    Details

    • Type: New Feature New Feature
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 5.0.8
    • Fix Version/s: 5.0.10
    • Component/s: component-report
    • Labels:
      None

      Description

      One of the big successes of Tapestry 4 was the component reference, including examples.

      Generating the component reference directly from the JavaDoc is a step in the right direction, but the complete solution needs the result to be easily navigated (a single page per class) and include examples.

      I believe the examples can be packaged as an XML file with the Java class, accessible to the JavaDoc tool and integrated into the documentation.

        Activity

        Hide
        Howard M. Lewis Ship added a comment -

        Just added ability to include images inside the xdoc.

        TODO: Document how to write xdoc.

        Show
        Howard M. Lewis Ship added a comment - Just added ability to include images inside the xdoc. TODO: Document how to write xdoc.

          People

          • Assignee:
            Howard M. Lewis Ship
            Reporter:
            Howard M. Lewis Ship
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development