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 handle entitities correctly inside <pre>blah</pre> tags #4184

Closed scabug closed 13 years ago

scabug commented 13 years ago

=== What steps will reproduce the problem (please be specific and use wikiformatting)? ===


build scaladoc on this file:

  /**
 * <pre>
 * scala [-classpath scalatest-&lt;version&gt;.jar:...] org.scalatest.tools.Runner 
[-D&lt;key&gt;=&lt;value&gt; [...]] [-p &lt;runpath&gt;] [reporter [...]] 
[-n &lt;includes&gt;] [-l &lt;excludes&gt;] [-c] [-s &lt;suite class name&gt; 
[...]] [-j &lt;junit class name&gt; [...]] [-m &lt;members-only suite path&gt; 
[...]] [-w &lt;wildcard suite path&gt; [...]] [-t &lt;TestNG config file 
path&gt; [...]]
 * </pre>
 *
**/

class Fred

=== What is the expected behavior? ===

Should see:

scala [-classpath scalatest-.jar:...] org.scalatest.tools.Runner [-D= [...]] [-p ] [reporter [...]] [-n ] [-l ] [-c] [-s [...]] [-j [...]] [-m [...]] [-w [...]] [-t <TestNG config file path> [...]]

=== What do you see instead? ===

scala [-classpath scalatest-<version>.jar:...] org.scalatest.tools.Runner [-D<key>=<value> [...]] [-p <runpath>] [reporter [...]] [-n <includes>] [-l <excludes>] [-c] [-s <suite class name> [...]] [-j <junit class name> [...]] [-m <members-only suite path> [...]] [-w <wildcard suite path> [...]] [-t <TestNG config file path> [...]]

=== Additional information === (for instance, a link to a relevant mailing list discussion)

Seems to not work on any entities - e.g.; " displays as "

=== What versions of the following are you using? ===

scabug commented 13 years ago

Imported From: https://issues.scala-lang.org/browse/SI-4184?orig=1 Reporter: @wallachd Attachments:

scabug commented 13 years ago

@dubochet said: (In r24186) [scaladoc] Scaladoc recognises HTML entities in comments, and leaves them untouched (except in code blocks defined using wiki syntax). Fixes #4184. No review.

scabug commented 13 years ago

@dubochet said: Note however that the previous behaviour was according to the [http://lampsvn.epfl.ch/trac/scala/wiki/Scaladoc/AuthorDocs?version=16 then-current specification] (see section on HTML element tags in pre code blocks).

The [http://lampsvn.epfl.ch/trac/scala/wiki/Scaladoc/AuthorDocs specification] has been updated to describe the new behaviour.