[libsigcplusplus/libsigc++-2-8] Reference docs: Main page: Mention CMake.



commit b11cd21ed0c8113286878152f26684110d375f23
Author: Murray Cumming <murrayc murrayc com>
Date:   Tue Mar 15 12:46:10 2016 +0100

    Reference docs: Main page: Mention CMake.
    
    And generally make this like the version in master for libsigc++-3.0.

 sigc++/sigc++.h |   26 ++++++++++++++++++++++----
 1 files changed, 22 insertions(+), 4 deletions(-)
---
diff --git a/sigc++/sigc++.h b/sigc++/sigc++.h
index 24d3424..b37a889 100644
--- a/sigc++/sigc++.h
+++ b/sigc++/sigc++.h
@@ -65,17 +65,35 @@
  * g++ program.cc -o program `pkg-config --cflags --libs sigc++-2.0`
  * @endcode
  *
+ * @subsection autotools Using Autotools
+ *
  * Alternatively, if using autoconf, use the following in @c configure.ac:
  * @code
- * PKG_CHECK_MODULES([LIBSIGC], [sigc++-2.0])
+ * PKG_CHECK_MODULES([DEPS], [sigc++-2.0])
  * @endcode
- * Then use the generated @c LIBSIGC_CFLAGS and @c LIBSIGC_LIBS variables
+ * Then use the generated @c DEPS_CFLAGS and @c DEPS_LIBS variables
  * in the project @c Makefile.am files. For example:
  * @code
- * program_CPPFLAGS = $(LIBSIGC_CFLAGS)
- * program_LDADD = $(LIBSIGC_LIBS)
+ * yourprogram_CPPFLAGS = $(DEPS_CFLAGS)
+ * yourprogram_LDADD = $(DEPS_LIBS)
  * @endcode
  *
+ * Your @c PKG_CHECK_MODULES() call should also mention any other libraries that
+ * you need to use via pkg-config.
+ *
+ * @subsection cmake Using CMake
+ *
+ * If using CMake, use the following in @c CMakeList.txt:
+ * @code
+ * include(FindPkgConfig)
+ * pkg_check_modules(DEPS REQUIRED sigc++-2.0)
+ * include_directories(${DEPS_INCLUDE_DIRS})
+ * target_link_libraries(yourprogram ${DEPS_LIBRARIES})
+ * @endcode
+ *
+ * Your @c pkg_check_modules() call should also mention any other libraries that
+ * you need to use via pkg-config.
+ *
  * @section scope Scope of Documentation
  *
  * libsigc++ contains many template functions and template classes/structs,


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]