diff options
| author | Brad King <brad.king@kitware.com> | 2014-06-12 17:57:37 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2014-06-12 17:59:00 (GMT) |
| commit | a81531817ef26f4e23933274c2317fd698336c04 (patch) | |
| tree | b98a326988b4cd6b90a04f38cfe45b927ace3998 /Help | |
| parent | d8319f0fc99fb628cbe33c3cc9169c2bd3a97f40 (diff) | |
| download | CMake-a81531817ef26f4e23933274c2317fd698336c04.zip CMake-a81531817ef26f4e23933274c2317fd698336c04.tar.gz CMake-a81531817ef26f4e23933274c2317fd698336c04.tar.bz2 | |
Help: Organize add_library command documentation
Add a section for each library type signature. Add a table of contents
at the top for the html builder.
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/command/add_library.rst | 19 |
1 files changed, 15 insertions, 4 deletions
diff --git a/Help/command/add_library.rst b/Help/command/add_library.rst index 746d524..18d8fe3 100644 --- a/Help/command/add_library.rst +++ b/Help/command/add_library.rst @@ -1,8 +1,15 @@ add_library ----------- +.. only:: html + + .. contents:: + Add a library to the project using the specified source files. +Normal Libraries +^^^^^^^^^^^^^^^^ + :: add_library(<name> [STATIC | SHARED | MODULE] @@ -44,7 +51,8 @@ the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for available expressions. See the :manual:`cmake-buildsystem(7)` manual for more on defining buildsystem properties. --------------------------------------------------------------------------- +Imported Libraries +^^^^^^^^^^^^^^^^^^ :: @@ -65,7 +73,8 @@ variant :prop_tgt:`IMPORTED_LOCATION_<CONFIG>`) which specifies the location of the main library file on disk. See documentation of the ``IMPORTED_*`` and ``INTERFACE_*`` properties for more information. --------------------------------------------------------------------------- +Object Libraries +^^^^^^^^^^^^^^^^ :: @@ -93,7 +102,8 @@ systems may not like targets that have only object files, so consider adding at least one real source file to any target that references ``$<TARGET_OBJECTS:objlib>``. --------------------------------------------------------------------------- +Alias Libraries +^^^^^^^^^^^^^^^ :: @@ -111,7 +121,8 @@ operand of :command:`set_property`, :command:`set_target_properties`, :command:`target_link_libraries` etc. An ``ALIAS`` target may not be installed or exported. --------------------------------------------------------------------------- +Interface Libraries +^^^^^^^^^^^^^^^^^^^ :: |