Documenting APIs and bug #15 from Dominique Hazael-Massieux on 2014-05-07 (public-webplatform@w3.org from May 2014)

From: Dominique Hazael-Massieux <dom@w3.org>
Date: Wed, 07 May 2014 15:51:06 +0200
To: public-webplatform@w3.org
Message-ID: <1399470666.4415.20.camel@cumulustier>

Hi,

Bug #15 [1] highlights a killer bug for documenting APIs: it means that
when you document the parameters of a given method, the parameters are
not displayed in the correct order, making the documentation basically
misleading.

While the bug is reported on the canvas API, it applies really to any
method documentation, making WPD pretty much unusable for documenting
APIs.

I've suggested a couple of possible approaches to fix this in [1] (none
great unfortunately); but since I haven't seen much activity on this,
and given how critical the bug seems to me, I thought I would raise
attention to it on the list as well.

Dom

1. http://project.webplatform.org/tmpl/issues/15

Received on Wednesday, 7 May 2014 13:51:20 UTC