mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-10 07:40:03 -06:00
Code Issues Packages Projects Releases Wiki Activity

FindGTK2: Fix documentation formatting

Browse Source 
Fixes: #20223
This commit is contained in:
Brad King
2020-01-21 12:05:45 -05:00
parent ba93119ac3
commit 763beb5944
1 changed files with 51 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

115
Modules/FindGTK2.cmake
View File

@@ -5,96 +5,83 @@
FindGTK2
--------
Find the GTK2 widget libraries and several of its
other optional components like ``gtkmm``, ``glade``, and ``glademm``.
NOTE: If you intend to use version checking, CMake 2.6.2 or later is
::
required.
Find the GTK2 widget libraries and several of its other optional components
like ``gtkmm``, ``glade``, and ``glademm``.
Specify one or more of the following components as you call this find
module. See example below.
::
gtk
gtkmm
glade
glademm
* ``gtk``
* ``gtkmm``
* ``glade``
* ``glademm``
Result Variables
^^^^^^^^^^^^^^^^
The following variables will be defined for your use
::
GTK2_FOUND - Were all of your specified components found?
GTK2_INCLUDE_DIRS - All include directories
GTK2_LIBRARIES - All libraries
GTK2_TARGETS - All imported targets
GTK2_DEFINITIONS - Additional compiler flags
::
GTK2_VERSION - The version of GTK2 found (x.y.z)
GTK2_MAJOR_VERSION - The major version of GTK2
GTK2_MINOR_VERSION - The minor version of GTK2
GTK2_PATCH_VERSION - The patch version of GTK2
``GTK2_FOUND``
Were all of your specified components found?
``GTK2_INCLUDE_DIRS``
All include directories
``GTK2_LIBRARIES``
All libraries
``GTK2_TARGETS``
All imported targets
``GTK2_DEFINITIONS``
Additional compiler flags
``GTK2_VERSION``
The version of GTK2 found (x.y.z)
``GTK2_MAJOR_VERSION``
The major version of GTK2
``GTK2_MINOR_VERSION``
The minor version of GTK2
``GTK2_PATCH_VERSION``
The patch version of GTK2
Input Variables
^^^^^^^^^^^^^^^
Optional variables you can define prior to calling this module:
::
``GTK2_DEBUG``
Enables verbose debugging of the module
``GTK2_ADDITIONAL_SUFFIXES``
Allows defining additional directories to search for include files
GTK2_DEBUG - Enables verbose debugging of the module
GTK2_ADDITIONAL_SUFFIXES - Allows defining additional directories to
search for include files
Example Usage
^^^^^^^^^^^^^
Call :command:`find_package` once. Here are some examples to pick from:
Require GTK 2.6 or later:
================= Example Usage:
.. code-block:: cmake
::
find_package(GTK2 2.6 REQUIRED gtk)
Call find_package() once, here are some examples to pick from:
Require GTK 2.10 or later and Glade:
.. code-block:: cmake
find_package(GTK2 2.10 REQUIRED gtk glade)
::
Search for GTK/GTKMM 2.8 or later:
Require GTK 2.6 or later
find_package(GTK2 2.6 REQUIRED gtk)
.. code-block:: cmake
find_package(GTK2 2.8 COMPONENTS gtk gtkmm)
Use the results:
::
.. code-block:: cmake
Require GTK 2.10 or later and Glade
find_package(GTK2 2.10 REQUIRED gtk glade)
::
Search for GTK/GTKMM 2.8 or later
find_package(GTK2 2.8 COMPONENTS gtk gtkmm)
::
if(GTK2_FOUND)
include_directories(${GTK2_INCLUDE_DIRS})
add_executable(mygui mygui.cc)
target_link_libraries(mygui ${GTK2_LIBRARIES})
endif()
if(GTK2_FOUND)
include_directories(${GTK2_INCLUDE_DIRS})
add_executable(mygui mygui.cc)
target_link_libraries(mygui ${GTK2_LIBRARIES})
endif()
#]=======================================================================]
# Version 1.6 (CMake 3.0)