Document orocos deployment

Hi,

We have some orocos application deploy with the deployer and the cdeployer. We need to document it. We want to list properties, methods, ports, etc. For ports, we need to document connected peers and connection name (as written in the deployment xml file).

Is Orocos 1.8 is providing a documentation solution?

If no, are you interested to add it in 1.8 ?

Mike

Document orocos deployment

On Monday 26 July 2010 16:24:07 Michaël Presseau wrote:
> Hi,
>
> We have some orocos application deploy with the deployer and the cdeployer.
> We need to document it. We want to list properties, methods, ports, etc.
> For ports, we need to document connected peers and connection name (as
> written in the deployment xml file).
>
> Is Orocos 1.8 is providing a documentation solution?

There is no such tool. People are looking to do this for 2.0 using a component
loader which writes the component interface to an XML file. This tool won't
work for 1.x components. It will also use a new xml format.

For 1.x, the best thing probably is to make a derivative of
DeploymentComponent that has the feature to introspect a peer and dump it to
some file format. We can not browse connections yet, but I have heard there are
patches in the making for 1.x.

>
> If no, are you interested to add it in 1.8 ?

1.8 receives no more updates, and feature additions are always done in new
releases (1.12 for example). I believe most users would be interested in using
such a tool though.

Peter