Uploaded image for project: 'Thrift'
  1. Thrift
  2. THRIFT-681

The HTML generator does not handle JavaDoc style comments very well

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Major
    • Resolution: Fixed
    • 0.2
    • 0.9
    • Compiler (General)
    • 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.

      Attachments

        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

          People

            kburnett Kevin Burnett
            johnbartak John Bartak
            Votes:
            2 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: