From 87e07e36391976ee67650701f7d27f23b301e89c Mon Sep 17 00:00:00 2001
From: Florent Lamiraux <florent@laas.fr>
Date: Thu, 22 Jan 2015 17:37:01 +0100
Subject: [PATCH] Write documentation main page.

---
 include/gepetto/viewer/corba/doc.hh | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 include/gepetto/viewer/corba/doc.hh

diff --git a/include/gepetto/viewer/corba/doc.hh b/include/gepetto/viewer/corba/doc.hh
new file mode 100644
index 0000000..21b6dca
--- /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
-- 
GitLab