Przeglądaj źródła

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.
Brad King 11 lat temu
rodzic
commit
a81531817e
1 zmienionych plików z 15 dodań i 4 usunięć
  1. 15 4
      Help/command/add_library.rst

+ 15 - 4
Help/command/add_library.rst

@@ -1,8 +1,15 @@
 add_library
 add_library
 -----------
 -----------
 
 
+.. only:: html
+
+   .. contents::
+
 Add a library to the project using the specified source files.
 Add a library to the project using the specified source files.
 
 
+Normal Libraries
+^^^^^^^^^^^^^^^^
+
 ::
 ::
 
 
   add_library(<name> [STATIC | SHARED | MODULE]
   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 available expressions.  See the :manual:`cmake-buildsystem(7)`
 manual for more on defining buildsystem properties.
 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
 location of the main library file on disk.  See documentation of the
 ``IMPORTED_*`` and ``INTERFACE_*`` properties for more information.
 ``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
 adding at least one real source file to any target that references
 ``$<TARGET_OBJECTS:objlib>``.
 ``$<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
 :command:`target_link_libraries` etc.  An ``ALIAS`` target may not be
 installed or exported.
 installed or exported.
 
 
---------------------------------------------------------------------------
+Interface Libraries
+^^^^^^^^^^^^^^^^^^^
 
 
 ::
 ::