iCub Software Repository Documentation

Welcome to my brain!

This is the iCub online code documentation (the iCub manual can be found elsewhere: http://wiki.icub.org/wiki/Manual). This is the result of an automatic process that parses the doxygen documentation in the repository. For this reason the information here at times can be innaccurate or completely broken!

Topics:

• Software installation.
• Software - most of the software (including iCub modules )
• Applications - a list of documented applications (collections of modules)
• Tutorials - a set of tutorials to learn how to use the software
• The documentation for contributed software is here: Contrib documentation
• iCub ChangeLog
• Programmer's checklist:
  • Compile status - check if your code is compiling on a test server
  • Licensing - have you declared your authorship, and rights granted?
  • Coding guidelines - some tips on how to write your code
  • Modules and CMake - some tips on how to make your code compilable
  • Committing to the repository - things to check before committing files to the repository
• Reference material:
  • The The iCub manual
  • The RobotCub Website.
  • Our software architecture, YARP.

This documentation is developed by scanning all source code in icub-main/src and icub-tutorials. If your comments or classes are not showing up, try running:

  cd icub-main
  doxygen conf/Doxyfile-main-tutorials.txt

locally on your repository, to figure out what's going on. The output can be browsed at doc/html/index.html.

This page can be edited at src/doc/main.dox.