search

scala / bug

Scala 2 bug reports only. Please, no questions — proper bug reports only.
https://scala-lang.org
232 stars 21 forks source link

scaladoc doesn't parse everything #7286

Open scabug opened 11 years ago

scabug commented 11 years ago

Given this comment:

  /** Sets sync var `response` to doc comment information for a given symbol.
   *
   *  @param   sym        The symbol whose doc comment should be retrieved (might come from a classfile)
   *  @param   source     The source file that's supposed to contain the definition
   *  @param   site       The symbol where 'sym' is observed
   *  @param   fragments  All symbols that can contribute to the generated documentation
   *                      together with their source files.
   *  @param   response   A response that will be set to the following:
   *                      If `source` contains a definition of a given symbol that has a doc comment,
   *                      the (expanded, raw, position) triplet for a comment, otherwise ("", "", NoPosition).
   *  Note: This operation does not automatically load sources that are not yet loaded.
   */

the parsed comment doesn't contain the last "Note" body.

scabug commented 11 years ago

Imported From: https://issues.scala-lang.org/browse/SI-7286?orig=1 Reporter: @vigdorchik

scabug commented 9 years ago

@kzys said: At least, the last "Note" body is appended to the last @param.

Maybe we can count the number of the leading spaces on the body, to consider it as a separate paragraph. However introducing such a space-sensibility (like YAML, Python, or Haskell) might screw up something else.