Commit 3c1bdcfa authored by Mike Kremer's avatar Mike Kremer

Updated documentation to contain cmake stuff.

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@7219 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 1d91c455
......@@ -79,4 +79,27 @@
* The created application bundle (that contains binaries, libs and shared files) is to be found in the <b>Build</b>
* 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:
*
* <code>include(plugin)</code>
*
* You then have to add the following line which configures the build parameters
* of your plugin:
*
* <code>openflipper_plugin()</code>
*
* 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.
*
*/
......@@ -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.
*
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment