W3C home > Mailing lists > Public > public-media-annotation@w3.org > May 2010

Minor remarks on API doc

From: Florian Stegmaier <stegmai@dimis.fim.uni-passau.de>
Date: Tue, 11 May 2010 11:19:17 +0200
Message-Id: <F7F57547-5E1F-4A12-96F5-2C6E22EE2FDB@dimis.fim.uni-passau.de>
To: public-media-annotation@w3.org
Dear all,

i just had a look at the API doc [1] while preparing the status codes  
draft. I found several issues:

- section 2 scenario description bullet 3 second sentence: ...This  - 
is- can be an API... (is should be removed)
- section 3.1.1.: examples missing for getDiagnosis, getOriginalData,  
getSourceFormatsWithValues, selectMAResource (here we should be  
complete, because a user would be happy to have examples for every  
mehtod stub)
- section 3.1.1.: getDiagnosis: change description to: This operation  
allows to retrieve the status code. See <a...>Section 4</a> for  
details. (we should not speek of errors any more)

Best,
Florian

[1] http://dev.w3.org/2008/video/mediaann/mediaont-api-1.0/mediaont-api-1.0.html
_____________________________
Dipl. Inf. Florian Stegmaier
Chair of Distributed Information Systems
University of Passau
Innstr. 43
94032 Passau

Room 248 ITZ
Tel.: +49 851 509 3063
Fax: +49 851 509 3062
stegmai@dimis.fim.uni-passau.de
https://www.dimis.fim.uni-passau.de/iris/
http://twitter.com/fstegmai
_____________________________
Received on Tuesday, 11 May 2010 09:18:27 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Tuesday, 11 May 2010 09:18:27 GMT