Re: [Playerstage-developers] changing the frequency via PLAYER_PLAYER_REQ_DATAFREQ

[Geoffrey B. <g....@au...>]

I've written some documentation at the top of playerc.h and committed 
that. I've also submitted a patch to add protocol-oriented documentation 
(for writers of client libraries) to playertcp.h.

Gepff

Brian Gerkey wrote:
> 
> On Mar 9, 2006, at 11:43 AM, Geoffrey Biggs wrote:
> 
>>
>>> There's also a need to document all of this, both from the  protocol  
>>> perspective and the client writer's perspective.
>>
>>
>> I'm happy to do this for the protocol and c/c++/python clients  (since 
>> they all have the same behaviour), but I'm not sure where in  the docs 
>> I should put it.
> 
> 
> The protocol-level description should go in the libplayertcp section:
> 
> http://playerstage.sourceforge.net/doc/Player-2.0.0/player/ 
> group__libplayertcp.html
> 
> It's generated from the comment block at the top of  libplayertcp/ 
> playertcp.h.
> 
> For the client-specific documentation, the details can go in the  
> comment blocks preceding the function calls that affect data delivery  
> (e.g., playerc_client_set_replace_rule).  But it's an important  enough 
> concept that an extra section that tells how the system works  would be 
> great.  For example, in libplayerc/playerc.h, you could add  a Doxygen 
> group that explains the data delivery issues (use the  
> libplayerc_example group as a template).  No code; it's just a big  
> comment in the file.
> 
> Send me patches for any files you don't have write access to and I'll  
> put them in.
> 
>     brian.

-- 
Robotics research group, University of Auckland
http://www.ece.auckland.ac.nz/~gbig005/