summaryrefslogtreecommitdiffstats
path: root/Modules/GenerateExportHeader.cmake
diff options
context:
space:
mode:
authorStephen Kelly <steveire@gmail.com>2011-08-25 18:38:13 (GMT)
committerStephen Kelly <steveire@gmail.com>2011-08-25 18:39:01 (GMT)
commit5ca8c565bc3ebabea06bd7de655d9a120a7f008c (patch)
treec45106607e2e720b3cb2e88dd93e6ce07591989c /Modules/GenerateExportHeader.cmake
parent75596e62f9a54c36943be0a89a0ad9874f50bf99 (diff)
downloadCMake-5ca8c565bc3ebabea06bd7de655d9a120a7f008c.zip
CMake-5ca8c565bc3ebabea06bd7de655d9a120a7f008c.tar.gz
CMake-5ca8c565bc3ebabea06bd7de655d9a120a7f008c.tar.bz2
Fix up verbatim code sections of the dox.
Diffstat (limited to 'Modules/GenerateExportHeader.cmake')
-rw-r--r--Modules/GenerateExportHeader.cmake18
1 files changed, 1 insertions, 17 deletions
diff --git a/Modules/GenerateExportHeader.cmake b/Modules/GenerateExportHeader.cmake
index b6901e4..0f5c413 100644
--- a/Modules/GenerateExportHeader.cmake
+++ b/Modules/GenerateExportHeader.cmake
@@ -28,13 +28,9 @@
# This means that in the simplest case, users of these functions will be equivalent to:
#
# add_compiler_export_flags()
-#
# add_library(somelib someclass.cpp)
-#
# generate_export_header(somelib)
-#
# install(TARGETS somelib DESTINATION ${LIBRARY_INSTALL_DIR})
-#
# install(FILES
# someclass.h
# ${PROJECT_BINARY_DIR}/somelib_export.h DESTINATION ${INCLUDE_INSTALL_DIR}
@@ -42,13 +38,10 @@
#
# And in the ABI header files:
#
-# \code
# #include "somelib_export.h"
-#
# class SOMELIB_EXPORT SomeClass {
-#
+# ...
# };
-# \endcode
#
# The CMake fragment will generate a file in the ${CMAKE_CURRENT_BUILD_DIR} called
# somelib_export.h containing the macros SOMELIB_EXPORT, SOMELIB_NO_EXPORT,
@@ -92,9 +85,7 @@
#
# add_library(shared_variant SHARED ${lib_SRCS})
# add_library(static_variant ${lib_SRCS})
-#
# generate_export_header(shared_variant BASE_NAME libshared_and_static)
-#
# set_target_properties(static_variant PROPERTIES COMPILE_FLAGS -DLIBSHARED_AND_STATIC_STATIC_DEFINE)
#
# This will cause the export macros to expand to nothing when building the static library.
@@ -103,16 +94,13 @@
# This macro can be used to remove deprecated code from preprocessor output.
#
# option(EXCLUDE_DEPRECATED "Exclude deprecated parts of the library" FALSE)
-#
# if (EXCLUDE_DEPRECATED)
# set(NO_BUILD_DEPRECATED DEFINE_NO_DEPRECATED)
# endif()
-#
# generate_export_header(somelib ${NO_BUILD_DEPRECATED})
#
# And then in somelib:
#
-# \code
# class SOMELIB_EXPORT SomeClass
# {
# public:
@@ -121,14 +109,10 @@
# #endif
# };
#
-# // ...
-#
# #ifndef SOMELIB_NO_DEPRECATED
# void SomeClass::oldMethod() { }
# #endif
#
-# \endcode
-#
# If PREFIX_NAME is specified, the argument will be used as a prefix to all
# generated macros.
#