airbus_docgen

This repository holds a tool to autogenerate documentation, this program will generate a html documentation for a desired package or workspace

Contents

1. Execution

1. Execution:

The launch file airbus_docgen.launch can be used to call the tool:

roslaunch airbus_docgen airbus_docgen.launch output_path:="/tmp/docu" ros_pkg:="/home/user/my_workspace"

or:

roslaunch airbus_docgen airbus_docgen.launch output_path:="/tmp/docu" ros_pkg:="package_name"

Input parameters are:

• output_path: the path where should be saved the generated documentation (optional, by default /tmp/docu)
• ros_pkg: the name of the package that has to be documented or the name of the workspace that contains all the packages to be documented

In case you want to document your current workspace and save the documentation in the /tmp/docu directory, you can just call the index.py node:

rosrun airbus_docgen index.py

top

Changelog for package airbus_docgen

0.0.4 (2017-09-13)

0.0.3 (2017-09-06)

• update changelog
• Merge pull request #33 from ipa-nhg/Rename Rename packages
• renamed packages
• Merge github.com:ipa319/airbus_coop into Rename Conflicts: airbus_docgen/package.xml
• rename agi_docgen package to airbus_docgen
• Contributors: Nadia Hammoudeh García, ipa-nhg
• Merge pull request #33 from ipa-nhg/Rename Rename packages
• renamed packages
• Merge github.com:ipa319/airbus_coop into Rename Conflicts: airbus_docgen/package.xml
• rename agi_docgen package to airbus_docgen
• Contributors: Nadia Hammoudeh García, ipa-nhg

0.0.2 (2017-09-05)