summaryrefslogtreecommitdiffstats
path: root/Source/cmAddLibraryCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-10-16 13:28:12 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2013-10-16 13:28:12 (GMT)
commitc49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740 (patch)
tree96102c69673467ce7b922697cd5f378511249201 /Source/cmAddLibraryCommand.h
parent5029da5eac08171653a92b961c341f7ffcca3640 (diff)
parent7038a93a7eafa83d506dd73bed171dc72dfbd9a5 (diff)
downloadCMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.zip
CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.gz
CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.bz2
Merge topic 'doc-reStructuredText'
7038a93 Modules/readme.txt: Update steps to add module documentation a77e308 CPack: Replace #<type> markup with reStructuredText equivalent e7ca48f Help: Factor out cmake-generator-expressions manual page 97e8650 Help: Factor out COMPILE_DEFINITIONS disclaimer duplication 8982161 Help: Factor out find_* command duplication 30b2186 Help: Factor out *_OUTPUT_(NAME|DIRECTORY).rst duplication bfe07aa Build Help documentation during CMake build using Sphinx 53ded59 Drop unused builtin documentation APIs 0c39a75 Drop the 'Full' field from cmDocumentationEntry e33d8d2 Drop builtin command documentation 399e9c4 Drop builtin property documentation 6035c04 get_property: Drop test for builtin property documentation 80a3273 Drop all documentation formatters except Usage b336a1eb Teach COMPATIBLE_INTERFACE_* checks to use Help .rst documents ec6df36 Teach --help-* options to load documentation from .rst files 25f2877 Add class cmRST to do basic reStructuredText processing ...
Diffstat (limited to 'Source/cmAddLibraryCommand.h')
-rw-r--r--Source/cmAddLibraryCommand.h121
1 files changed, 0 insertions, 121 deletions
diff --git a/Source/cmAddLibraryCommand.h b/Source/cmAddLibraryCommand.h
index 64d048b..1001043 100644
--- a/Source/cmAddLibraryCommand.h
+++ b/Source/cmAddLibraryCommand.h
@@ -43,127 +43,6 @@ public:
*/
virtual const char* GetName() const { return "add_library";}
- /**
- * Succinct documentation.
- */
- virtual const char* GetTerseDocumentation() const
- {
- return "Add a library to the project using the specified source files.";
- }
-
- /**
- * More documentation.
- */
- virtual const char* GetFullDocumentation() const
- {
- return
- " add_library(<name> [STATIC | SHARED | MODULE]\n"
- " [EXCLUDE_FROM_ALL]\n"
- " source1 source2 ... sourceN)\n"
- "Adds a library target called <name> to be built from the "
- "source files listed in the command invocation. "
- "The <name> corresponds to the logical target name and must be "
- "globally unique within a project. "
- "The actual file name of the library built is constructed based on "
- "conventions of the native platform "
- "(such as lib<name>.a or <name>.lib)."
- "\n"
- "STATIC, SHARED, or MODULE may be given to specify the type of library "
- "to be created. "
- "STATIC libraries are archives of object files for use when linking "
- "other targets. "
- "SHARED libraries are linked dynamically and loaded at runtime. "
- "MODULE libraries are plugins that are not linked into other targets "
- "but may be loaded dynamically at runtime using dlopen-like "
- "functionality. "
- "If no type is given explicitly the type is STATIC or SHARED based "
- "on whether the current value of the variable BUILD_SHARED_LIBS is "
- "true. "
- "For SHARED and MODULE libraries the POSITION_INDEPENDENT_CODE "
- "target property is set to TRUE automatically."
- "\n"
- "By default the library file will be created in the build tree "
- "directory corresponding to the source tree directory in which "
- "the command was invoked. "
- "See documentation of the ARCHIVE_OUTPUT_DIRECTORY, "
- "LIBRARY_OUTPUT_DIRECTORY, and RUNTIME_OUTPUT_DIRECTORY "
- "target properties to change this location. "
- "See documentation of the OUTPUT_NAME target property to change "
- "the <name> part of the final file name. "
- "\n"
- "If EXCLUDE_FROM_ALL is given the corresponding property will be "
- "set on the created target. "
- "See documentation of the EXCLUDE_FROM_ALL target property for "
- "details."
- "\n"
- "The add_library command can also create IMPORTED library "
- "targets using this signature:\n"
- " add_library(<name> <SHARED|STATIC|MODULE|UNKNOWN> IMPORTED\n"
- " [GLOBAL])\n"
- "An IMPORTED library target references a library file located "
- "outside the project. "
- "No rules are generated to build it. "
- "The target name has scope in the directory in which it is created "
- "and below, but the GLOBAL option extends visibility. "
- "It may be referenced like any target built within the project. "
- "IMPORTED libraries are useful for convenient reference from "
- "commands like target_link_libraries. "
- "Details about the imported library are specified by setting "
- "properties whose names begin in \"IMPORTED_\". "
- "The most important such property is IMPORTED_LOCATION "
- "(and its per-configuration version IMPORTED_LOCATION_<CONFIG>) "
- "which specifies the location of the main library file on disk. "
- "See documentation of the IMPORTED_* properties for more information."
- "\n"
- "The signature\n"
- " add_library(<name> OBJECT <src>...)\n"
- "creates a special \"object library\" target. "
- "An object library compiles source files but does not archive or link "
- "their object files into a library. "
- "Instead other targets created by add_library or add_executable may "
- "reference the objects using an expression of the form "
- "$<TARGET_OBJECTS:objlib> as a source, where \"objlib\" is the "
- "object library name. "
- "For example:\n"
- " add_library(... $<TARGET_OBJECTS:objlib> ...)\n"
- " add_executable(... $<TARGET_OBJECTS:objlib> ...)\n"
- "will include objlib's object files in a library and an executable "
- "along with those compiled from their own sources. "
- "Object libraries may contain only sources (and headers) that compile "
- "to object files. "
- "They may contain custom commands generating such sources, but not "
- "PRE_BUILD, PRE_LINK, or POST_BUILD commands. "
- "Object libraries cannot be imported, exported, installed, or linked."
- " "
- "Some native build 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>."
- "\n"
- "The signature\n"
- " add_library(<name> ALIAS <target>)\n"
- "creates an alias, such that <name> can be used to refer to <target> "
- "in subsequent commands. The <name> does not appear in the generated "
- "buildsystem as a make target. The <target> may not be an IMPORTED "
- "target or an ALIAS. Alias targets can be used as linkable targets, "
- "targets to read properties from. They can also be tested for "
- "existance with the "
- "regular if(TARGET) subcommand. The <name> may not be used to modify "
- "properties of <target>, that is, it may not be used as the operand of "
- "set_property, set_target_properties, target_link_libraries etc. An "
- "ALIAS target may not be installed of exported."
- "\n"
- "The signature\n"
- " add_library(<name> INTERFACE)\n"
- "creates an interface target. An interface target does not directly "
- "create build output, though it may have properties set on it and it "
- "may be installed, exported and imported. Typically the INTERFACE_* "
- "properties are populated on the interface target using the "
- "set_property(), target_link_libraries(), target_include_directories() "
- "and target_compile_defintions() commands, and then it is used as an "
- "argument to target_link_libraries() like any other target."
- ;
- }
-
cmTypeMacro(cmAddLibraryCommand, cmCommand);
};