W3C home > Mailing lists > Public > public-script-coord@w3.org > January to March 2012

Re: Specification links in code generated from WebIDL

From: Robin Berjon <robin@berjon.com>
Date: Fri, 24 Feb 2012 08:46:23 +0900
Cc: public-script-coord@w3.org
Message-Id: <2F81AD5D-F8B1-4654-A6FF-B2388B77ACA9@berjon.com>
To: Stefan Haustein <haustein@google.com>
Hi Stefan,

On Feb 22, 2012, at 21:39 , Stefan Haustein wrote:
> The HTML 5 Canvas spec (1) provides link targets of the form
> 
> CONSTANT_PREFIX + interfaceName.toLowerCase() + "-" + operationName.toLowercase();
> 
> This makes it quite easy to link to the relevant parts of the specification, for instance in IDEs and / or generated JavaDoc comments. Unfortunately, other specifications such as WebGL or TypedArrays do not follow this schema. 
> 
> Do you think it would make sense to support this link schema as a general recommendation in WebIDL?

I'm not sure that WebIDL would be the best place to make this recommendation, but even if we had a good place the above does seem to be too simple. Notably, you can have multiple partial interfaces with the same name, overloaded operations, etc.

-- 
Robin Berjon - http://berjon.com/ - @robinberjon

Coming up soon: I'm teaching a W3C online course on Mobile Web Apps
http://www.w3devcampus.com/writing-great-web-applications-for-mobile/
Received on Thursday, 23 February 2012 23:46:48 UTC

This archive was generated by hypermail 2.3.1 : Wednesday, 8 May 2013 19:30:05 UTC