Skip to content

scaladoc needs to be properly html-escaped. #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
mseddon opened this issue Oct 12, 2015 · 0 comments
Closed

scaladoc needs to be properly html-escaped. #160

mseddon opened this issue Oct 12, 2015 · 0 comments

Comments

@mseddon
Copy link
Contributor

mseddon commented Oct 12, 2015

as reported by @ochrons via gitter, a trivial issue with an easy fix:

'for some reason in http://www.scala-js.org/api/scalajs-dom/0.8/#org.scalajs.dom.raw.Document the "comment" section is not closed and all the method names look big because of that.
Probably because the comment includes elements such as <body> and <table> making ScalaDoc confused'

Good to catch them all in a single PR (we don't use nested /** */ comments afaik so an easy regex search ought to work). Perhaps put a note in the scala-js project's CONTRIBUTING.md?

Something worth looking out for when reviewing PRs for now.

Scalastyle also has an org.scalastyle.scalariform.ScalaDocChecker plugin, and I'm not sure we're using it in scala-js, (or how good it is for catching this kind of error, or if it introduces more problems than it would solve...). Eventually maybe we should maintain a duplicate of that task here.
mseddon added a commit to mseddon/scala-js-dom that referenced this issue Nov 14, 2015
@mseddon
Fix scala-js#160: HTML Escape scaladoc
7dde9a7
mseddon added a commit to mseddon/scala-js-dom that referenced this issue Nov 14, 2015
@mseddon
Fix scala-js#160: HTML escape scaladoc
91c9068
@sjrd sjrd closed this as completed in cda56a8 Nov 14, 2015
sjrd added a commit that referenced this issue Nov 14, 2015
@sjrd
Merge pull request #173 from mseddon/scaladoc-htmlescape
e5b10a7 
Fix #160: HTML escape scaladoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mseddon