diff --git a/include/gepetto/viewer/corba/doc.hh b/include/gepetto/viewer/corba/doc.hh new file mode 100644 index 0000000000000000000000000000000000000000..21b6dca76adba65ce5007f11202a3876f5c66f94 --- /dev/null +++ b/include/gepetto/viewer/corba/doc.hh @@ -0,0 +1,18 @@ +/// \mainpage +/// \section gepetto_viewer_corba_introduction +/// +/// This package implements a corba server embedding gepetto-viewer library. +/// +/// The idl interface of the server is defined by gepetto::corbaserver::GraphicalInterface. +/// +/// To use the graphical interface via python, +/// \li start executable +/// \code gepetto-viewer-server \endcode. +/// \li in a python terminal, create a client +/// \code +/// from gepetto.corbaserver import Client +/// client = Client () +/// # open a new window +/// client.gui.createWindow ("w") +/// # refer to the idl interface to control gepetto-viewer. +/// \endcode