Skip to content
Snippets Groups Projects
Commit e92240e9 authored by Joseph Mirabel's avatar Joseph Mirabel Committed by Joseph Mirabel
Browse files

Add more documentation

parent 17de7efe
No related branches found
No related tags found
No related merge requests found
/// \mainpage Gepetto Viewer user interfaces
///
/// This package provides two compatible interfaces to vizualise robots:
/// \li a \ref gepetto_viewer_corba_introduction "command line interface in Python"
/// \li a \ref gepetto_gui_introduction "graphical user interface" which is fully compatible with the Python interface.
/// \page gepetto_gui_introduction Gepetto Gui introduction
///
/// Graphical user interface for the gepetto-viewer package.
///
/// \section gui_using_interface Using the interface
///
/// To start the interface, use
/// \code{bash} gepetto-gui \endcode
///
/// To get some help on the command line options, use
/// \code{bash} gepetto-gui --help \endcode
///
/// \section gui_extending_interface Extending the interface
///
/// There are two ways of extending the interface: Python and C++. Python
/// plugins are easier to write than C++ plugins, but they do not offer
/// full control of the interface (yet).
///
/// \subsection python_plugins Python plugins
///
/// See the documentation of gepetto::gui::PythonWidget to know how to write
/// plugins in Python. You may have a look at the file
/// \ref pyplugins/gepetto/gui/pythonwidget.py which is an example.
///
/// The Python console is a good tool for debugging. The following variables
/// are accessible:
/// \li \c mainWindow: gepetto::gui::MainWindow
/// \li \c osg: the widget responsible for the first created window (class gepetto::gui::OSGWidget)
///
/// \subsection cpp_plugins C++ Plugins
///
/// See documentation of gepetto::gui::PluginInterface, for details on how to write a plugin.
/// \mainpage
/// \section gepetto_viewer_corba_introduction
/// \page gepetto_viewer_corba_introduction Gepetto Viewer server
///
/// This package implements a corba server embedding gepetto-viewer library.
///
......@@ -7,9 +6,9 @@
///
/// To use the graphical interface via python,
/// \li start executable
/// \code gepetto-viewer-server \endcode.
/// \code{bash} gepetto-viewer-server \endcode.
/// \li in a python terminal, create a client
/// \code
/// \code{py}
/// from gepetto.corbaserver import Client
/// client = Client ()
/// # open a new window
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment