[Performous-commit] Lasse Karkkainen : LibDA header docs and config.h with version macros

[Lasse Kärkkäi. <tr...@us...>]

Module: performous
Branch: dance
Commit: 8b318c7c2e81cd83f626ddf2796f3e2f96f48932

Author: Lasse Karkkainen <tro...@tr...>
Date:   Thu Nov 26 16:31:36 2009 +0200

LibDA header docs and config.h with version macros

---

 libs/libda/CMakeLists.txt              |    9 +++++++--
 libs/libda/cmake/config.h.in           |    9 +++++++++
 libs/libda/include/libda/audio.hpp     |    7 +++----
 libs/libda/include/libda/audio_dev.hpp |    7 +++++++
 libs/libda/include/libda/mixer.hpp     |    5 ++++-
 5 files changed, 30 insertions(+), 7 deletions(-)

diff --git a/libs/libda/CMakeLists.txt b/libs/libda/CMakeLists.txt
index c856b95..763e8d7 100644
--- a/libs/libda/CMakeLists.txt
+++ b/libs/libda/CMakeLists.txt
@@ -25,8 +25,13 @@ set(LibDA_PLUGIN_DIR "lib${LIB_SUFFIX}/libda")
 
 include_directories(include)
 
-FILE(GLOB HEADER_FILES "include/libda/*")
-install(FILES ${HEADER_FILES} DESTINATION include/libda)
+# Store version data in config.h
+set(CONFIG_H ${CMAKE_CURRENT_BINARY_DIR}/config.h)
+configure_file(cmake/config.h.in ${CONFIG_H} ESCAPE_QUOTES @ONLY)
+
+# Install include files
+file(GLOB HEADER_FILES "include/libda/*")
+install(FILES ${HEADER_FILES} ${CONFIG_H} DESTINATION include/libda)
 
 if(CMAKE_COMPILER_IS_GNUCXX)
 	message(STATUS "GCC detected, adding compile flags")
diff --git a/libs/libda/cmake/config.h.in b/libs/libda/cmake/config.h.in
new file mode 100644
index 0000000..b08238c
--- /dev/null
+++ b/libs/libda/cmake/config.h.in
@@ -0,0 +1,9 @@
+#ifndef LIBDA_CONFIG_H
+#define LIBDA_CONFIG_H
+
+#define LIBDA_VERSION "@LibDA_VERSION@"
+#define LIBDA_VERSION_MAJOR @LibDA_VERSION_MAJOR@
+#define LIBDA_VERSION_MINOR @LibDA_VERSION_MINOR@
+
+#endif
+
diff --git a/libs/libda/include/libda/audio.hpp b/libs/libda/include/libda/audio.hpp
index 10e5cf5..4626f36 100644
--- a/libs/libda/include/libda/audio.hpp
+++ b/libs/libda/include/libda/audio.hpp
@@ -2,16 +2,15 @@
 #define LIBDA_AUDIO_HPP_INCLUDED
 
 /**
-@file audio.hpp LibDA public interface.
+@file audio.hpp LibDA audio I/O public interface
 
-Link with libda when you use this.
+Link with libda when you use this. ABI will change, API is likely to change in
+future versions (which hopefully will bring API and ABI compatibility).
 **/
 
 // Library version number, may be used to test whether a certain function is
 // available. Incremented by one each time a new release is done.
 
-#define LIBDA_VERSION 0
-
 #include "sample.hpp"
 #include <boost/function.hpp>
 #include <boost/scoped_ptr.hpp>
diff --git a/libs/libda/include/libda/audio_dev.hpp b/libs/libda/include/libda/audio_dev.hpp
index ad8ab00..10970f2 100644
--- a/libs/libda/include/libda/audio_dev.hpp
+++ b/libs/libda/include/libda/audio_dev.hpp
@@ -1,6 +1,13 @@
 #ifndef AUDIO_DEV_HPP_INCLUDED
 #define AUDIO_DEV_HPP_INCLUDED
 
+/**
+@file audio_dev.hpp Audio plugin interface. Not very stable yet.
+
+This requires linking with libda and the ABI is not stable yet. The API might
+also change.
+**/
+
 #include <libda/audio.hpp>
 #include <plugin++/plugin.hpp>
 
diff --git a/libs/libda/include/libda/mixer.hpp b/libs/libda/include/libda/mixer.hpp
index 370056e..29ae38e 100644
--- a/libs/libda/include/libda/mixer.hpp
+++ b/libs/libda/include/libda/mixer.hpp
@@ -2,7 +2,10 @@
 #define LIBDA_MIXER_HPP_INCLUDED
 
 /**
-@file mixer.hpp LibDA mixer interface.
+@file mixer.hpp LibDA mixer interface, version 1.
+
+This appears to be too complex and will probably be removed in later release in
+favor of something easier and faster.
 
 Link with libda when you use this.
 **/