W3C home > Mailing lists > Public > public-webapps@w3.org > April to June 2009

Automated API specification generation

From: Marcin Hanclik <Marcin.Hanclik@access-company.com>
Date: Thu, 4 Jun 2009 17:56:09 +0200
To: "public-device-apis@w3.org" <public-device-apis@w3.org>
CC: public-webapps <public-webapps@w3.org>
Message-ID: <FAA1D89C5BAF1142A74AF116630A9F2C0A26ED9170@OBEEX01.obe.access-company.com>
Hi All,

This is FYI.
To accelerate the API standardization process we can use some tools.
As you know BONDI uses widl format (WebIDL + doxygen).
http://bondi.omtp.org/1.0/apis/BONDI_Interface_Patterns_v1.0.html#dox

It has its problems, but it helped us a lot.
We could discuss first the patterns and document format, e.g. XML-based.
This is planned already for BONDI.

In ACCESS I prepared a tool that helped me ensure some quality aspect of the BONDI specs.
It is known as API database approach, since one of the intermediate format is a database that enables SQL queries to the spec.
The output is e.g. here:
http://bondi01.obe.access-company.com/1_0_3309_41/

The tool enables me to prepare specification checkers, one of them is here:
http://bondi01.obe.access-company.com/1_0_3309_41/checker_versions.html
(it checks whether version of the widl file was specified correctly)

Another nice aspect are the statistics:
http://bondi01.obe.access-company.com/1_0_3309_41/stats.html

I assume a tool, format, etc.  could help the group concentrate on the real problems and the syntactical issue could be spotted more easily.

Thanks.

Kind regards,
Marcin

Marcin Hanclik
ACCESS Systems Germany GmbH
Tel: +49-208-8290-6452  |  Fax: +49-208-8290-6465
Mobile: +49-163-8290-646
E-Mail: marcin.hanclik@access-company.com

________________________________
________________________________________

Access Systems Germany GmbH
Essener Strasse 5 | D-46047 Oberhausen
HRB 13548 Amtsgericht Duisburg
Geschaeftsfuehrer: Michel Piquemal, Tomonori Watanabe, Yusuke Kanda

www.access-company.com

CONFIDENTIALITY NOTICE
This e-mail and any attachments hereto may contain information that is privileged or confidential, and is intended for use only by the
individual or entity to which it is addressed. Any disclosure, copying or distribution of the information by anyone else is strictly prohibited.
If you have received this document in error, please notify us promptly by responding to this e-mail. Thank you.
Received on Thursday, 4 June 2009 15:57:02 GMT

This archive was generated by hypermail 2.3.1 : Tuesday, 26 March 2013 18:49:31 GMT