Jelajahi Sumber

FindSQLite3: Sync documentation

- Added intro code block showing how to use this module.
- Resorted variables and synced their descriptions with other similar
  find modules.
Peter Kokot 6 bulan lalu
induk
melakukan
d55fffca3e
1 mengubah file dengan 19 tambahan dan 10 penghapusan
  1. 19 10
      Modules/FindSQLite3.cmake

+ 19 - 10
Modules/FindSQLite3.cmake

@@ -7,9 +7,14 @@ FindSQLite3
 
 
 .. versionadded:: 3.14
 .. versionadded:: 3.14
 
 
-Finds the SQLite 3 library.  SQLite is a small, fast, self-contained,
-high-reliability, and full-featured SQL database engine written in C, intended
-for embedding in applications.
+Finds the SQLite 3 library:
+
+.. code-block:: cmake
+
+  find_package(SQLite3 [<version>] [...])
+
+SQLite is a small, fast, self-contained, high-reliability, and full-featured
+SQL database engine written in C, intended for embedding in applications.
 
 
 Imported Targets
 Imported Targets
 ^^^^^^^^^^^^^^^^
 ^^^^^^^^^^^^^^^^
@@ -23,17 +28,21 @@ This module provides the following :ref:`Imported Targets`:
 Result Variables
 Result Variables
 ^^^^^^^^^^^^^^^^
 ^^^^^^^^^^^^^^^^
 
 
-This module sets the following variables:
+This module defines the following variables:
+
+``SQLite3_FOUND``
+  Boolean indicating whether (the requested version of) SQLite library is
+  found.
+
+``SQLite3_VERSION``
+  The version of SQLite library found.
 
 
 ``SQLite3_INCLUDE_DIRS``
 ``SQLite3_INCLUDE_DIRS``
-  Include directories containing the ``sqlite3.h`` and related headers needed
-  to use SQLite.
+  Include directories containing the ``<sqlite3.h>`` and related headers
+  needed to use SQLite.
+
 ``SQLite3_LIBRARIES``
 ``SQLite3_LIBRARIES``
   Libraries needed to link against to use SQLite.
   Libraries needed to link against to use SQLite.
-``SQLite3_VERSION``
-  Version of the SQLite library found.
-``SQLite3_FOUND``
-  Boolean indicating whether the SQLite library is found.
 
 
 Examples
 Examples
 ^^^^^^^^
 ^^^^^^^^