diff --git a/Doxygen/Developer/building.docu b/Doxygen/Developer/building.docu index eb6f897619b4247fb17f397f13ed5f89bdfbf76c..ea6e7fe1bca04e7ba78af0e012fc597aa661d0bf 100644 --- a/Doxygen/Developer/building.docu +++ b/Doxygen/Developer/building.docu @@ -79,4 +79,27 @@ * The created application bundle (that contains binaries, libs and shared files) is to be found in the Build * directory. * + * \section cmake_plugin Building OpenFlipper Plugins with CMake + * + * Building plugins with CMake is very simple. The OpenFlipper CMake build system + * expects a CMakeLists.txt file in each of the plugin's directories. + * So when developing a plugin, just make sure there is a CMakeLists.txt in + * your plugin's directory. In this file include the global file plugin.cmake + * which specifies the openflipper_plugin() function: + * + * include(plugin) + * + * You then have to add the following line which configures the build parameters + * of your plugin: + * + * openflipper_plugin() + * + * Note: There are several parameters that one can pass to this function. + * Usage: + * + * \include example/cmake_plugin_usage.txt + * + * For a detailed description of the parameters see the CMake documentation. + * For an example of how to build a simple plugin see \ref ex1. + * */ diff --git a/Doxygen/Developer/tutorial1.docu b/Doxygen/Developer/tutorial1.docu index adb90185a6420ea6bcd7af86cad0c657dd4cd6ab..b7247b7c7ab4a35228496d6f4c3221eda4eb3d4b 100644 --- a/Doxygen/Developer/tutorial1.docu +++ b/Doxygen/Developer/tutorial1.docu @@ -65,18 +65,15 @@ * This step is very easy, so let's start. In your plugin's root directory * create a CMakeLists.txt file. * - * Our first line includes OpenFlipper's predefined cmake plugin functions. This allows us to simply call + * Our first line includes OpenFlipper's predefined cmake plugin functions. This allows us to simply call the * \c openflipper_plugin() macro in order to build our code as a plugin. Our project file then looks like this: * * CMakeLists.txt * \include example/CMakeLists.txt * - * Note that you have several options that can be passed to the openflipper_plugin() function: - * The usage of this function is: - * - * \include example/cmake_plugin_usage.txt - * - * See the cmake documentation for detailed information on the different parameters. + * Note that you have several options that can be passed to the openflipper_plugin() function, + * see \ref cmake_plugin for details. For our example project we just have to + * leave this line as it is. * * Now, when building OpenFlipper with cmake, your plugin should be found and built automatically. *