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

Allow comments on interfaces #163

Merged
merged 1 commit into from Mar 14, 2013
Merged

Conversation

dirkschulze
Copy link
Contributor

This allows comments to be added to interfaces. This recovers the functionality of the old respec tool for commenting.

@marcoscaceres
Copy link
Member

Is this for adding comments to WebIDL? (i.e., this would show up in the generated WebIDL?)

@darobin darobin merged commit e1a161d into w3c:develop Mar 14, 2013
@darobin
Copy link
Member

darobin commented Mar 14, 2013

This was conflicting so I closed it but applied on my end. Thanks!

@marcoscaceres
Copy link
Member

Ok, but if this going to allow people to create non-conforming WebIDL... not so good, eh?

@dirkschulze
Copy link
Contributor Author

It is necessary for being compatible with existing specification drafts using the old respec.js tool. I wonder why I can not fine it in WebIDL spec either. I need to talk with Cameron. All implementations support comments. A reason for a formal objection to WebIDL ;)

@dirkschulze
Copy link
Contributor Author

Ok, I was about to write a mail to the WG, but found this in the grammar:

whitespace = [\t\n\r ]+|[\t\n\r ]((//.|/._?_/)[\t\n\r ])+

""
… both whitespace and comments, are ignored while parsing.
""

So commenting is allowed. Even comments with /* .. */ seem to be allowed.

@darobin
Copy link
Member

darobin commented Mar 14, 2013

Yes, of course comments are allowed. I'm not sure what @marcoscaceres was thinking about, I suspect there's a misunderstanding.

@dirkschulze I'm curious about the old ReSpec tool you mention that supported comments. Are you thinking of ReSpec.pm?

@dirkschulze
Copy link
Contributor Author

@marcoscaceres
Copy link
Member

Sorry. Clearly, I'm a dumb ass. I didn't think comments were allowed for some reason.

@darobin
Copy link
Member

darobin commented Mar 14, 2013

@dirkschulze Funny, that's not an official version but a fork with some added features. I'd never heard of it before :)

@dirkschulze
Copy link
Contributor Author

@darobin You used it in http://dev.w3.org/2009/dap/device/ . Did you write this clone?

@darobin
Copy link
Member

darobin commented Mar 14, 2013

No, that page uses the canonical ReSpec v1. The FXTF one you point to is using something else!

@dirkschulze
Copy link
Contributor Author

@darobin You are right. The Web-Animations guys took the spec from the domain originally. Changes were done by Brian Birtles: https://dvcs.w3.org/hg/FXTF/log/f0bee7474714/web-anim/respec/respec.js

Most likely just Web-Animations and Transformation Matrix uses comments, Constructor references and NamedConstructor references yet. I'll speak with Brian to back-port the necessary changes to GitHub.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants