kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix up verbatim code sections of the dox.

This commit is contained in:
Stephen Kelly 2011-08-25 20:38:13 +02:00
parent 75596e62f9
commit 5ca8c565bc
1 changed files with 1 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Modules/GenerateExportHeader.cmake
View File

@ -28,13 +28,9 @@
# This means that in the simplest case, users of these functions will be equivalent to: # This means that in the simplest case, users of these functions will be equivalent to:
# #
# add_compiler_export_flags() # add_compiler_export_flags()
#
# add_library(somelib someclass.cpp) # add_library(somelib someclass.cpp)
#
# generate_export_header(somelib) # generate_export_header(somelib)
#
# install(TARGETS somelib DESTINATION ${LIBRARY_INSTALL_DIR}) # install(TARGETS somelib DESTINATION ${LIBRARY_INSTALL_DIR})
#
# install(FILES # install(FILES
# someclass.h # someclass.h
# ${PROJECT_BINARY_DIR}/somelib_export.h DESTINATION ${INCLUDE_INSTALL_DIR} # ${PROJECT_BINARY_DIR}/somelib_export.h DESTINATION ${INCLUDE_INSTALL_DIR}
@ -42,13 +38,10 @@
# #
# And in the ABI header files: # And in the ABI header files:
# #
# \code
# #include "somelib_export.h" # #include "somelib_export.h"
#
# class SOMELIB_EXPORT SomeClass { # class SOMELIB_EXPORT SomeClass {
# # ...
# }; # };
# \endcode
# #
# The CMake fragment will generate a file in the ${CMAKE_CURRENT_BUILD_DIR} called # 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, # somelib_export.h containing the macros SOMELIB_EXPORT, SOMELIB_NO_EXPORT,
@ -92,9 +85,7 @@
# #
# add_library(shared_variant SHARED ${lib_SRCS}) # add_library(shared_variant SHARED ${lib_SRCS})
# add_library(static_variant ${lib_SRCS}) # add_library(static_variant ${lib_SRCS})
#
# generate_export_header(shared_variant BASE_NAME libshared_and_static) # generate_export_header(shared_variant BASE_NAME libshared_and_static)
#
# set_target_properties(static_variant PROPERTIES COMPILE_FLAGS -DLIBSHARED_AND_STATIC_STATIC_DEFINE) # 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. # 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. # This macro can be used to remove deprecated code from preprocessor output.
# #
# option(EXCLUDE_DEPRECATED "Exclude deprecated parts of the library" FALSE) # option(EXCLUDE_DEPRECATED "Exclude deprecated parts of the library" FALSE)
#
# if (EXCLUDE_DEPRECATED) # if (EXCLUDE_DEPRECATED)
# set(NO_BUILD_DEPRECATED DEFINE_NO_DEPRECATED) # set(NO_BUILD_DEPRECATED DEFINE_NO_DEPRECATED)
# endif() # endif()
#
# generate_export_header(somelib ${NO_BUILD_DEPRECATED}) # generate_export_header(somelib ${NO_BUILD_DEPRECATED})
# #
# And then in somelib: # And then in somelib:
# #
# \code
# class SOMELIB_EXPORT SomeClass # class SOMELIB_EXPORT SomeClass
# { # {
# public: # public:
@ -121,14 +109,10 @@
# #endif # #endif
# }; # };
# #
# // ...
#
# #ifndef SOMELIB_NO_DEPRECATED # #ifndef SOMELIB_NO_DEPRECATED
# void SomeClass::oldMethod() { } # void SomeClass::oldMethod() { }
# #endif # #endif
# #
# \endcode
#
# If PREFIX_NAME is specified, the argument will be used as a prefix to all # If PREFIX_NAME is specified, the argument will be used as a prefix to all
# generated macros. # generated macros.
# #