diff options
author | Brad King <brad.king@kitware.com> | 2013-09-16 18:38:23 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-16 13:22:36 (GMT) |
commit | 399e9c46d88c12507f1a762e69225c5ab9f4ac08 (patch) | |
tree | b220aa74b78aaccdb819e7a4d76a78dea3654b1f /Source/cmSourceFile.cxx | |
parent | 6035c0458e511bae94959ff4e01800dd14384fc2 (diff) | |
download | CMake-399e9c46d88c12507f1a762e69225c5ab9f4ac08.zip CMake-399e9c46d88c12507f1a762e69225c5ab9f4ac08.tar.gz CMake-399e9c46d88c12507f1a762e69225c5ab9f4ac08.tar.bz2 |
Drop builtin property documentation
Drop all DefineProperty calls for non-chained properties. Drop the
documentation from the chained ones. The documentation for all
properties is now in Help/prop_*/*.rst files.
Diffstat (limited to 'Source/cmSourceFile.cxx')
-rw-r--r-- | Source/cmSourceFile.cxx | 174 |
1 files changed, 0 insertions, 174 deletions
diff --git a/Source/cmSourceFile.cxx b/Source/cmSourceFile.cxx index 8bb7d96..d747309 100644 --- a/Source/cmSourceFile.cxx +++ b/Source/cmSourceFile.cxx @@ -16,7 +16,6 @@ #include "cmMakefile.h" #include "cmSystemTools.h" #include "cmake.h" -#include "cmDocumentCompileDefinitions.h" //---------------------------------------------------------------------------- cmSourceFile::cmSourceFile(cmMakefile* mf, const char* name): @@ -382,176 +381,3 @@ void cmSourceFile::SetCustomCommand(cmCustomCommand* cc) this->CustomCommand = cc; delete old; } - -//---------------------------------------------------------------------------- -void cmSourceFile::DefineProperties(cmake *cm) -{ - // define properties - cm->DefineProperty - ("ABSTRACT", cmProperty::SOURCE_FILE, - "Is this source file an abstract class.", - "A property on a source file that indicates if the source file " - "represents a class that is abstract. This only makes sense for " - "languages that have a notion of an abstract class and it is " - "only used by some tools that wrap classes into other languages."); - - cm->DefineProperty - ("COMPILE_FLAGS", cmProperty::SOURCE_FILE, - "Additional flags to be added when compiling this source file.", - "These flags will be added to the list of compile flags when " - "this source file builds. Use COMPILE_DEFINITIONS to pass additional " - "preprocessor definitions."); - - cm->DefineProperty - ("COMPILE_DEFINITIONS", cmProperty::SOURCE_FILE, - "Preprocessor definitions for compiling a source file.", - "The COMPILE_DEFINITIONS property may be set to a " - "semicolon-separated list of preprocessor " - "definitions using the syntax VAR or VAR=value. Function-style " - "definitions are not supported. CMake will automatically escape " - "the value correctly for the native build system (note that CMake " - "language syntax may require escapes to specify some values). " - "This property may be set on a per-configuration basis using the name " - "COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case name " - "(ex. \"COMPILE_DEFINITIONS_DEBUG\").\n" - "CMake will automatically drop some definitions that " - "are not supported by the native build tool. " - "The VS6 IDE does not support definition values with spaces " - "(but NMake does). Xcode does not support per-configuration " - "definitions on source files.\n" - CM_DOCUMENT_COMPILE_DEFINITIONS_DISCLAIMER); - - cm->DefineProperty - ("COMPILE_DEFINITIONS_<CONFIG>", cmProperty::SOURCE_FILE, - "Per-configuration preprocessor definitions on a source file.", - "This is the configuration-specific version of " - "COMPILE_DEFINITIONS. Note that Xcode does not support " - "per-configuration source file flags so this property will " - "be ignored by the Xcode generator."); - - cm->DefineProperty - ("EXTERNAL_OBJECT", cmProperty::SOURCE_FILE, - "If set to true then this is an object file.", - "If this property is set to true then the source file " - "is really an object file and should not be compiled. " - "It will still be linked into the target though."); - - cm->DefineProperty - ("Fortran_FORMAT", cmProperty::SOURCE_FILE, - "Set to FIXED or FREE to indicate the Fortran source layout.", - "This property tells CMake whether a given Fortran source file " - "uses fixed-format or free-format. " - "CMake will pass the corresponding format flag to the compiler. " - "Consider using the target-wide Fortran_FORMAT property if all " - "source files in a target share the same format."); - - cm->DefineProperty - ("GENERATED", cmProperty::SOURCE_FILE, - "Is this source file generated as part of the build process.", - "If a source file is generated by the build process CMake will " - "handle it differently in terms of dependency checking etc. " - "Otherwise having a non-existent source file could create problems."); - - cm->DefineProperty - ("HEADER_FILE_ONLY", cmProperty::SOURCE_FILE, - "Is this source file only a header file.", - "A property on a source file that indicates if the source file " - "is a header file with no associated implementation. This is " - "set automatically based on the file extension and is used by " - "CMake to determine if certain dependency information should be " - "computed."); - - cm->DefineProperty - ("KEEP_EXTENSION", cmProperty::SOURCE_FILE, - "Make the output file have the same extension as the source file.", - "If this property is set then the file extension of the output " - "file will be the same as that of the source file. Normally " - "the output file extension is computed based on the language " - "of the source file, for example .cxx will go to a .o extension."); - - cm->DefineProperty - ("LABELS", cmProperty::SOURCE_FILE, - "Specify a list of text labels associated with a source file.", - "This property has meaning only when the source file is listed in " - "a target whose LABELS property is also set. " - "No other semantics are currently specified."); - - cm->DefineProperty - ("LANGUAGE", cmProperty::SOURCE_FILE, - "What programming language is the file.", - "A property that can be set to indicate what programming language " - "the source file is. If it is not set the language is determined " - "based on the file extension. Typical values are CXX C etc. Setting " - "this property for a file means this file will be compiled. " - "Do not set this for headers or files that should not be compiled."); - - cm->DefineProperty - ("LOCATION", cmProperty::SOURCE_FILE, - "The full path to a source file.", - "A read only property on a SOURCE FILE that contains the full path " - "to the source file."); - - cm->DefineProperty - ("MACOSX_PACKAGE_LOCATION", cmProperty::SOURCE_FILE, - "Place a source file inside a Mac OS X bundle, CFBundle, or framework.", - "Executable targets with the MACOSX_BUNDLE property set are built " - "as Mac OS X application bundles on Apple platforms. " - "Shared library targets with the FRAMEWORK property set are built " - "as Mac OS X frameworks on Apple platforms. " - "Module library targets with the BUNDLE property set are built " - "as Mac OS X CFBundle bundles on Apple platforms. " - "Source files listed in the target with this property set will " - "be copied to a directory inside the bundle or framework content " - "folder specified by the property value. " - "For bundles the content folder is \"<name>.app/Contents\". " - "For frameworks the content folder is " - "\"<name>.framework/Versions/<version>\". " - "For cfbundles the content folder is " - "\"<name>.bundle/Contents\" (unless the extension is changed). " - "See the PUBLIC_HEADER, PRIVATE_HEADER, and RESOURCE target " - "properties for specifying files meant for Headers, PrivateHeaders, " - "or Resources directories."); - - cm->DefineProperty - ("OBJECT_DEPENDS", cmProperty::SOURCE_FILE, - "Additional files on which a compiled object file depends.", - "Specifies a semicolon-separated list of full-paths to files on which " - "any object files compiled from this source file depend. " - "An object file will be recompiled if any of the named files is newer " - "than it.\n" - "This property need not be used to specify the dependency of a " - "source file on a generated header file that it includes. " - "Although the property was originally introduced for this purpose, it " - "is no longer necessary. " - "If the generated header file is created by a custom command in the " - "same target as the source file, the automatic dependency scanning " - "process will recognize the dependency. " - "If the generated header file is created by another target, an " - "inter-target dependency should be created with the add_dependencies " - "command (if one does not already exist due to linking relationships)."); - - cm->DefineProperty - ("OBJECT_OUTPUTS", cmProperty::SOURCE_FILE, - "Additional outputs for a Makefile rule.", - "Additional outputs created by compilation of this source file. " - "If any of these outputs is missing the object will be recompiled. " - "This is supported only on Makefile generators and will be ignored " - "on other generators."); - - cm->DefineProperty - ("SYMBOLIC", cmProperty::SOURCE_FILE, - "Is this just a name for a rule.", - "If SYMBOLIC (boolean) is set to true the build system will be " - "informed that the source file is not actually created on disk but " - "instead used as a symbolic name for a build rule."); - - cm->DefineProperty - ("WRAP_EXCLUDE", cmProperty::SOURCE_FILE, - "Exclude this source file from any code wrapping techniques.", - "Some packages can wrap source files into alternate languages " - "to provide additional functionality. For example, C++ code " - "can be wrapped into Java or Python etc using SWIG etc. " - "If WRAP_EXCLUDE is set to true (1 etc) that indicates that " - "this source file should not be wrapped."); -} - |