Mercurial > irccd
comparison cmake/function/IrccdDefineLibrary.cmake @ 874:bf2bdb41f181
doc: improve doxygen documentation
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 15 Aug 2019 19:47:53 +0200 |
parents | 6af323b76970 |
children | 6baa070e083c |
comparison
equal
deleted
inserted
replaced
873:f50164e4f794 | 874:bf2bdb41f181 |
---|---|
18 | 18 |
19 # | 19 # |
20 # irccd_define_library | 20 # irccd_define_library |
21 # -------------------- | 21 # -------------------- |
22 # | 22 # |
23 # Synopsis: | |
24 # | |
23 # irccd_define_library( | 25 # irccd_define_library( |
24 # TARGET target name | 26 # TARGET target name |
25 # SOURCES src1, src2, srcn | 27 # SOURCES src1, src2, srcn |
26 # EXPORT (Optional) set to true to export library through irccd | 28 # EXPORT (Optional) set to true to export library through irccd |
29 # and install it | |
27 # HEADERS (Optional) directory of headers to install | 30 # HEADERS (Optional) directory of headers to install |
28 # FLAGS (Optional) C/C++ flags (without -D) | 31 # FLAGS (Optional) C/C++ flags (without -D) |
29 # LIBRARIES (Optional) libraries to link | 32 # LIBRARIES (Optional) libraries to link |
30 # LOCAL_INCLUDES (Optional) local includes for the target only | 33 # LOCAL_INCLUDES (Optional) local includes for the target only |
31 # PUBLIC_INCLUDES (Optional) includes to share with target dependencies | 34 # PUBLIC_INCLUDES (Optional) includes to share with target dependencies |
32 # ) | 35 # ) |
36 # | |
37 # Create a library and optionally install it. | |
38 # | |
39 # The function create a new library named with the parameter TARGET, you should | |
40 # prefix it with "lib" as its the convention within irccd (e.g. libfoo), the | |
41 # prefix is automatically removed. | |
42 # | |
43 # The argument SOURCES should contains the C++ source files and HEADERS should | |
44 # points to a directory to be installed verbatim in the include directory. | |
45 # | |
46 # Optional argument FLAGS, LOCAL_INCLUDES, PUBLIC_INCLUDES, LIBRARIES may be | |
47 # passed to set compile flags, private includes, public includes and libraries | |
48 # respectively. | |
49 # | |
50 # If export boolean parameter is set, the library is exported and installed. | |
33 # | 51 # |
34 | 52 |
35 include(${CMAKE_CURRENT_LIST_DIR}/IrccdInstallDependencies.cmake) | 53 include(${CMAKE_CURRENT_LIST_DIR}/IrccdInstallDependencies.cmake) |
36 | 54 |
37 function(irccd_define_library) | 55 function(irccd_define_library) |