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

Escape documentation while generating non escaped documetation

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 0.9.3
    • Fix Version/s: 0.11.0
    • Component/s: Compiler (General)
    • Labels:
      None
    • Patch Info:
      Patch Available

      Description

      The HTML generated documentation from a .thrift don't format comments. They all appears as a one-liner.

      When not using the "noescape" tag, documentation comments should be displayed between "<pre>" tag to keep readability.

      This will allow comment such as this one to be displayed correctly (and not on one line):

          /**
           * This method is doing this and that.
           *
           * @param user
           *   Current identifier of the user
           *
           * @param password
           *   Some password
           *
           * @return
           *   Some data
           *
           * @throws ExceptionA
           * @throws ExceptionB
           */
          string doSomeStuff(
              1: string user,
              2: string pasword,
          ) throws (
              1: ExceptionA userException,
              2: ExceptionB systemException,
          )
      

        Attachments

          Activity

            People

            • Assignee:
              jking3 James E. King III
              Reporter:
              maxime.mouial maxime mouial
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: