W3C home > Mailing lists > Public > spec-prod@w3.org > October to December 2012

Re: ReSpec IDL: how to fill out descriptions of method parameters

From: James Craig <jcraig@apple.com>
Date: Fri, 30 Nov 2012 11:31:42 -0800
Message-id: <E3787F84-B1DF-48A2-93F4-CDCD820A856E@apple.com>
To: "spec-prod@w3.org" <spec-prod@w3.org>

FYI, I found the working link test examples which answered my question:
https://github.com/darobin/respec/blob/develop/tests/specifications/webidl.html

I had:
> <dl class="arguments">


I needed 
> <dl class="parameters">




On Nov 30, 2012, at 2:42 AM, James Craig <jcraig@apple.com> wrote:

> The spec does not mention how to do this:
> http://darobin.github.com/respec/docs/#webidl-support
> 
> …and the link form the spec to the test examples is broken.
> http://darobin.github.com/respec/docs/#examples
> 
> 
> I'm trying to figure out how to use ReSpec.js fill out the "Description" column for the method parameters, foo and bar.
> 
> 	interface Something {
> 		getter DOMstring doSomething(in DOMString foo, in optional DOMString bar)
> 	};
> 
> 
> I'm currently just listing the parameter descriptions in the main method description, but since there is an empty description field in the parameters table, I assume there is a way to do this already.
> 
> 	<dl title="interface Something" class="idl">
> 		<dt>getter DOMstring doSomething(in DOMString foo, in optional DOMString bar)</dt>
> 		<dd>
> 			<dl class="arguments">
> 				<dt><code>foo</code></dt><dd>Explanatory description for foo.</dd>
> 				<dt><code>foo</code></dt><dd>Explanatory description for bar.</dd>
> 			</dl>
> 		</dd>
> 	</dl>
> 
> 
> Thanks in advance.
> 
Received on Friday, 30 November 2012 19:32:12 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Friday, 30 November 2012 19:32:12 GMT