[ros-users] Package documentation

[Ken Conley]

You can make the manifest description arbitrarily long using XHTML
markup, but this is generally avoided.  For code inclusion, you can
use this macro:

http://www.ros.org/wiki/WikiMacros#GetTaggedCode

That is currently all we enable.

We generally encourage keeping much of the documentation in the wiki
so that the community can help contribute and maintain it.  It's been
very helpful for our own packages.

 - Ken

On Thu, Jan 27, 2011 at 5:20 AM, Steven Bellens
<steven.bellens at mech.kuleuven.be> wrote:
> Hi,
>
> Is there a way to keep all package documentation (from the ros wiki)
> together inside the package itself?
> I know the package description shows up automatically on the ros wiki,
> and I see that the mainpage.dox description is shown in the API
> overwiew.
> But can a more extensive description of a package also be shown on the
> wiki without adding it manually?
> Maybe we just add it all to the manifest file? However, that's not
> really where it belongs I guess.
>
> regards,
>
> Steven
> _______________________________________________
> ros-users mailing list
> ros-users at code.ros.org
> https://code.ros.org/mailman/listinfo/ros-users
>