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

Re: Specification links in code generated from WebIDL

From: Charles McCathieNevile <chaals@opera.com>
Date: Fri, 24 Feb 2012 00:55:53 +0100
To: "Stefan Haustein" <haustein@google.com>, "Robin Berjon" <robin@berjon.com>
Cc: public-script-coord@w3.org
Message-ID: <op.v95orfk6wxe0ny@widsith-3.local>
On Fri, 24 Feb 2012 00:46:23 +0100, Robin Berjon <robin@berjon.com> wrote:

> 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,

Nor am I. But some character called Berjon, and a bloke called Caceres  
were talking up an API cookbook recently as the sort of place where such  
advice would probably fit well...

> 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.

Yes. That said, something along these lines seems a good practice to the  
extent that it works... (i.e. don't expect it to be perfect or break other  
stuff trying to make it so, but if the cap does fit...)

cheers

-- 
Charles 'chaals' McCathieNevile  Opera Software, Standards Group
     je parle français -- hablo español -- jeg kan litt norsk
http://my.opera.com/chaals       Try Opera: http://www.opera.com
Received on Thursday, 23 February 2012 23:56:25 UTC

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