[Pcsclite-muscle] API Docs improvement

[Ludovic Rousseau]

2016-03-11 14:46 GMT+01:00 Maksim Ivanov <emaxx at google.com>:

> Hello Ludovic,
>
> Thanks for the fast replies!
>
>
> I additionally checked the code examples and found a couple of small
> issues:
>
> * Code example for SCardCancel: the sample looks like SCardCancel is
> called on the same thread as SCardGetStatusChange, which shouldn't
> happen probably. Also the SCardGetStatusChange argument values are a
> bit misleading: dwTimeout=0 means that no actual waiting will occur
> (and, hence, no cancellation is useful), rgReaderStates receives
> SCARD_READERSTATE instead of LPSCARD_READERSTATE, and
> cReaders=cReaders is not initialized to 1 in the sample code.
>
> * Code example for SCardControl: missing comma in pbSendBuffer assignment.
>
> * Code example for SCardListReaders: missing semicolon after
> assignment to dwReaders.
>
>
Fixed in  6cd24b9c83513c207cff39afbf9b653cbf8d004a

A better solution would be to include real/compilable code in Doxygen.


> What else I badly missed in the PC/SC-Lite docs is the clear
> description of what arguments are optional (i.e. can be NULL instead
> of the real pointers). Often this follows from the textual description
> of the function, or can be guessed. And in some cases this information
> cannot be derived from the context at all (like pioRecvPci argument of
> the SCardTransmit function).
>
> It would be great if this information would be easily available in the
> "Parameters" section of each function's description.
>

Good idea.

Bye

-- 
 Dr. Ludovic Rousseau
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.alioth.debian.org/pipermail/pcsclite-muscle/attachments/20160311/aedada52/attachment.html>