Skip to content
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.

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

MarkupParser.document documentation is gobbledygook #5102

Closed
scabug opened this issue Oct 20, 2011 · 5 comments
Closed

MarkupParser.document documentation is gobbledygook #5102

scabug opened this issue Oct 20, 2011 · 5 comments
Labels
docs out of scope scaladoc tool

Comments

@scabug
Copy link

scabug commented Oct 20, 2011

The documentation for Markupparser.document is gobbledygook:

def document (): Document
[22] prolog ::= XMLDecl? Misc* (doctypedecl Misc*)? [23] XMLDecl ::= '' [24] VersionInfo ::= S 'version' Eq ("'" VersionNum "'" | '"' VersionNum '"') [25] Eq ::= S? '=' S? [26] VersionNum ::= '1.0' [27] Misc ::= Comment | PI | S

Several other entries are also afflicted, e.g. attrDecl, element1, externalID and others beside.
@scabug
Copy link
Author

scabug commented Oct 20, 2011

Imported From: https://issues.scala-lang.org/browse/SI-5102?orig=1
Reporter: Alan Burlison (alanbur)
Affected Versions: 2.9.1

@scabug
Copy link
Author

scabug commented Oct 20, 2011

@heathermiller said (edited on Oct 20, 2011 1:35:29 PM UTC):
Please take a look at the nightly Scaladoc- this was a bug that has been fixed.

http://www.scala-lang.org/archives/downloads/distrib/files/nightly/docs/library/index.html#scala.xml.parsing.MarkupParser

Also, just an FYI- most of the additions to API documentation are not yet in the "current" API. So it's possible that more detailed API documentation for a specific class/trait/object you're interested in might be available in nightly.

@scabug
Copy link
Author

scabug commented Oct 20, 2011

@heathermiller said:
Fixed previously, has been in nightly.

@scabug
Copy link
Author

scabug commented Oct 20, 2011

Alan Burlison (alanbur) said:
Well, partly. The gobbledygook may now be well-formatted but it is still indecipherable. What is the documentation supposed to mean? And the problem is still there for the documentation of elementDecl, xEndTag and others. And what is the documentation for ch supposed to be telling us?

@scabug scabug added this to the Backlog milestone Apr 7, 2017
@ashawley
Copy link
Member

ashawley commented Feb 6, 2018

This can be closed and moved to http://github.com/scala/scala-xml

@SethTisue SethTisue removed this from the Backlog milestone Feb 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs out of scope scaladoc tool
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@SethTisue @ashawley @scabug