Thrift
  1. Thrift
  2. THRIFT-681

The HTML generator does not handle JavaDoc style comments very well

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 0.2
    • Fix Version/s: 0.9
    • Component/s: Compiler (General)
    • Labels:
      None

      Description

      If you create comments using the standard JavaDoc conventions of @param and @exception, the output that gets generated isn't the cleanest. It would be better if the list of parameters and exceptions were placed in a table with the appropriate headers rather than just outputting the @param and @exception tags into the HTML output.

      1. t_html_generator_JavaDoc.patch
        7 kB
        John Bartak
      2. screenshot-1.jpg
        84 kB
        John Bartak
      3. t_html_generator_JavaDoc.v2.patch
        8 kB
        Adrian Muraru
      4. Screenshot.png
        30 kB
        Adrian Muraru
      5. thrift-682-v2.patch
        1 kB
        Bryan Duxbury
      6. thrift-681-inline-parameter-doc-generation.patch
        24 kB
        Kevin Burnett
      7. thrift-681-inline-parameter-doc-generation.png
        24 kB
        Kevin Burnett

        Activity

        Bryan Duxbury made changes -
        Status Open [ 1 ] Closed [ 6 ]
        Assignee Kevin Burnett [ kburnett ]
        Fix Version/s 0.9 [ 12316294 ]
        Resolution Fixed [ 1 ]
        Kevin Burnett made changes -
        Bryan Duxbury made changes -
        Assignee Bryan Duxbury [ bryanduxbury ]
        Bryan Duxbury made changes -
        Attachment thrift-682-v2.patch [ 12470606 ]
        Bryan Duxbury made changes -
        Assignee Bryan Duxbury [ bryanduxbury ]
        Adrian Muraru made changes -
        Attachment t_html_generator_JavaDoc.v2.patch [ 12469495 ]
        Attachment Screenshot.png [ 12469496 ]
        Roger Meier made changes -
        Component/s Compiler (General) [ 12312311 ]
        John Bartak made changes -
        Attachment screenshot-1.jpg [ 12430784 ]
        John Bartak made changes -
        Field Original Value New Value
        Attachment t_html_generator_JavaDoc.patch [ 12430783 ]
        John Bartak created issue -

          People

          • Assignee:
            Kevin Burnett
            Reporter:
            John Bartak
          • Votes:
            2 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development