Add documentation of CMake macro GEPETTO_GUI_PLUGIN

cmake-modules/gepetto-viewer-corba-plugin.cmake

@@ -16,6 +16,7 @@
 # gepetto-viewer-corba  If not, see
 # <http://www.gnu.org/licenses/>.
 
+# See plugins/pluginskeleton/CMakeLists.txt for description of how to use this macro.
 MACRO(GEPETTO_GUI_PLUGIN PLUGIN_NAME)
 
   SET(options QT4 INSIDE_GEPETTO_VIEWER_CORBA)

plugins/pluginskeleton/CMakeLists.txt

@@ -22,6 +22,16 @@ ELSE()
   SET(QT4 "")
 ENDIF()
 
+## 1. Tells pkg-config to read qtversion and cmake_plugin from pkg config file.
+#
+#  LIST(APPEND PKG_CONFIG_ADDITIONAL_VARIABLES qtversion cmake_plugin)
+
+## 2. Include macro GEPETTO_GUI_PLUGIN
+#
+# INCLUDE(${GEPETTO_VIEWER_CORBA_PREFIX}/${GEPETTO_VIEWER_CORBA_CMAKE_PLUGIN})
+
+## 3. Call GEPETTO_GUI_PLUGIN as follows
+#
 GEPETTO_GUI_PLUGIN(pluginskeleton
   # Use this option only if you write a plugin within
   # gepetto-viewer-corba package