summaryrefslogtreecommitdiff
path: root/Help/prop_tgt/DEFINE_SYMBOL.rst
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 11:17:36 -0400
committerBrad King <brad.king@kitware.com>2013-10-15 14:12:03 -0400
commitf051814ed0e63badbfd68049354f36259dbf4b49 (patch)
treef4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Help/prop_tgt/DEFINE_SYMBOL.rst
parente94958e99c4dec26c86ce8b76d744c04ba960675 (diff)
downloadcmake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
Diffstat (limited to 'Help/prop_tgt/DEFINE_SYMBOL.rst')
-rw-r--r--Help/prop_tgt/DEFINE_SYMBOL.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/Help/prop_tgt/DEFINE_SYMBOL.rst b/Help/prop_tgt/DEFINE_SYMBOL.rst
new file mode 100644
index 0000000000..f47f135eaa
--- /dev/null
+++ b/Help/prop_tgt/DEFINE_SYMBOL.rst
@@ -0,0 +1,11 @@
+DEFINE_SYMBOL
+-------------
+
+Define a symbol when compiling this target's sources.
+
+DEFINE_SYMBOL sets the name of the preprocessor symbol defined when
+compiling sources in a shared library. If not set here then it is set
+to target_EXPORTS by default (with some substitutions if the target is
+not a valid C identifier). This is useful for headers to know whether
+they are being included from inside their library or outside to
+properly setup dllexport/dllimport decorations.