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

Exceptions Woes

From: Eliot Graff <Eliot.Graff@microsoft.com>
Date: Fri, 26 Oct 2012 18:23:49 +0000
To: "spec-prod@w3.org" <spec-prod@w3.org>
Message-ID: <CE3A5BFD1228D84A8D9C158EEC195FD53D9CE138@TK5EX14MBXW602.wingroup.windeploy.ntdev.microsoft.com>
Hi All.

I am having a heck of a time getting exceptions to render using ReSpec.

I see some content about exceptions in Robin's documentation [1], but I don't see any examples that actually generate a name and description on an exception that is on a method, say. I am trying to replicate something along the lines of the exception table for IndexedDB's cmp() method [2].

If I use the sample from the earlier documentation [3]:

                <dl class="idl" title="interface EliotReader : EventTarget">
        <dt>void raising ()</dt>
        <dd>
          This is an example of a method that raises an exception.
          <div class='exception' title='BoomBoomBoomBoom'>
            This is an exception that is raised as a whole, for a reason but without specific codes
            being mentioned.
          </div>
        </dd>
        <dt>void raising2 ()</dt>
        <dd>
          This is an example of a method that raises another exception.
          <dl class='exception' title='ImSoExceptional'>
            <dt>TOO_SEXY_ERR</dt>
            <dd>
              Raised whenever I walk out the door.
            </dd>
            <dt>COOL_FROOD_ERR</dt>
            <dd>
              Not a club you can buy your way into.
            </dd>
          </dl>
        </dd>
        <dt>void complexRaising2 ()</dt>
        <dd>
          This is an example of a method that does a bunch of things.
          <dl class='exception' title='ImSoExceptional'>
            <dt>TOO_SEXY_ERR</dt>
            <dd>
              Raised whenever I walk out the door.
            </dd>
            <dt>COOL_FROOD_ERR</dt>
            <dd>
              Not a club you can buy your way into.
              And we add a lot of text to see it all wrap. And we add a lot of text to see it all wrap.
              And we add a lot of text to see it all wrap. And we add a lot of text to see it all wrap.
            </dd>
          </dl>
          <dl class='parameters'>
            <dt>[Optional, TreastAsNull] unsigned short another</dt>
            <dd>
              This is another parameter, more complex. And we add a lot of text to see it all wrap.
              And we add a lot of text to see it all wrap. And we add a lot of text to see it all wrap.
              And we add a lot of text to see it all wrap. And we add a lot of text to see it all wrap.
            </dd>
          </dl>
          <div class='exception' title='JustForYouException'>
            This is an exception that is raised as a whole, for a reason but without specific codes
            being mentioned.
            And we add a lot of text to see it all wrap. And we add a lot of text to see it all wrap.
            And we add a lot of text to see it all wrap. And we add a lot of text to see it all wrap.
          </div>
        </dd>
                </dl>

The words show up, but they're plain text, in <dt><dd> pairs, rather than in a table as the parameters in the same methods get generated into tables. Is this a known issue, am I doing something wrong?

Thanks,

Eliot
[1] http://darobin.github.com/respec/docs
[2] http://dvcs.w3.org/hg/IndexedDB/raw-file/tip/Overview.html#widl-IDBFactory-cmp-short-any-first-any-second
[3] http://dev.w3.org/2009/dap/ReSpec.js/test-spec/webidl.html#exception-raising
Received on Friday, 26 October 2012 18:25:02 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Friday, 26 October 2012 18:25:03 GMT