Просмотр исходного кода

FindPostgreSQL: Modernize documentation layout

Brad King 7 лет назад
Родитель
Сommit
7a801b7dfb
1 измененных файлов с 15 добавлено и 8 удалено
  1. 15 8
      Modules/FindPostgreSQL.cmake

+ 15 - 8
Modules/FindPostgreSQL.cmake

@@ -7,14 +7,21 @@ FindPostgreSQL
 
 Find the PostgreSQL installation.
 
-This module defines
-
-::
-
-  PostgreSQL_LIBRARIES - the PostgreSQL libraries needed for linking
-  PostgreSQL_INCLUDE_DIRS - the directories of the PostgreSQL headers
-  PostgreSQL_LIBRARY_DIRS  - the link directories for PostgreSQL libraries
-  PostgreSQL_VERSION_STRING - the version of PostgreSQL found (since CMake 2.8.8)
+Result Variables
+^^^^^^^^^^^^^^^^
+
+This module will set the following variables in your project:
+
+``PostgreSQL_FOUND``
+  True if PostgreSQL is found.
+``PostgreSQL_LIBRARIES``
+  the PostgreSQL libraries needed for linking
+``PostgreSQL_INCLUDE_DIRS``
+  the directories of the PostgreSQL headers
+``PostgreSQL_LIBRARY_DIRS``
+  the link directories for PostgreSQL libraries
+``PostgreSQL_VERSION_STRING``
+  the version of PostgreSQL found
 #]=======================================================================]
 
 # ----------------------------------------------------------------------------