Re: [Playerstage-users] Reuire MORE PLayer / Stage Documentation

[Richard v. <va...@cs...>]

On 8-Mar-06, at 9:32 AM, Fred Labrosse wrote:

> On Wednesday 08 Mar 2006 01:44, Xavier Palathingal wrote:
>> I have a similar concern too...
>>
>>   I use the C++ client library, and I'll really appreaciate it if the
>> developers can put a pdf of the documentation online.Currently we  
>> have an
>> HTML version and the pdfs available are of old versions.
>
> I don't care about a pdf, but it's true that the docs are not  
> complete.  Loads
> of functions are only partially documented and doxygen throws loads  
> of errors
> when processing the files, producing incomplete docs.
>
> Also, in general, parameters are described, but possible values are  
> not.  For
> example, the last parameter of PlayerClient::SetReplaceRule() is  
> described as
> "Should we replace these messages" and is an int.  I don't know  
> what values I
> can put there.  Is that actually a bool?  So should it be 1 or 0?

> Another
> example is the doc of PlayerClient::Read():
>
> void   PlayerCc::PlayerClient::Read ()
>      been received, ensuring as up to date data as possible.
>
> Clearly, a bit is missing...
>
> Could something be done about that?  I understand that there are  
> nicer things
> to do, but... ;-)

Folks,

It's useful to have the errors and omissions pointed out, thanks. The  
maintainers are working on the code and docs when we can. Remember  
that if the docs are unclear you can check the sources for the  
definitive truth. The tree is big, so use grep to help you.

Volunteers willing to spend a few hours improving the docs are very  
welcome.

Richard/