From 721c1923e49cc10cec9821d0877d94237265ca6f Mon Sep 17 00:00:00 2001
From: Kirill Simonov <xi@resolvent.net>
Date: Sun, 21 May 2006 14:58:32 +0000
Subject: Add doxygen support.

---
 include/Makefile.am         | 18 +++++++++++++++++-
 include/yaml/yaml.h         |  9 +++++++++
 include/yaml/yaml_version.h | 18 +++++++++++++++---
 3 files changed, 41 insertions(+), 4 deletions(-)

(limited to 'include')

diff --git a/include/Makefile.am b/include/Makefile.am
index 29b04f3..5db6705 100644
--- a/include/Makefile.am
+++ b/include/Makefile.am
@@ -1 +1,17 @@
-nobase_include_HEADERS = yaml/yaml.h yaml/yaml_version.h yaml/yaml_error.h
+INCLUDES = yaml/yaml.h yaml/yaml_version.h yaml/yaml_error.h
+DOXYGEN_CFG = $(top_srcdir)/doc/doxygen.cfg
+
+nobase_include_HEADERS = $(INCLUDES)
+
+if DOXYGEN
+
+html: $(INCLUDES) $(DOXYGEN_CFG)
+	PACKAGE=$(PACKAGE) VERSION=$(VERSION) top_srcdir=$(top_srcdir) top_builddir=$(top_builddir) doxygen $(DOXYGEN_CFG)
+
+endif
+
+distclean-local:
+	-rm -rf $(top_builddir)/doc/html
+
+dist-hook: html
+	cp -a $(top_builddir)/doc/html $(top_distdir)/doc
diff --git a/include/yaml/yaml.h b/include/yaml/yaml.h
index eecfe10..64412c7 100644
--- a/include/yaml/yaml.h
+++ b/include/yaml/yaml.h
@@ -1,3 +1,12 @@
+/**
+ * @file yaml.h
+ * @brief Public interface for libyaml.
+ * 
+ * Include the header file with
+ * @code
+ * #include <yaml/yaml.h>
+ * @endcode
+ */
 
 #ifndef YAML_H
 #define YAML_H
diff --git a/include/yaml/yaml_version.h b/include/yaml/yaml_version.h
index bcea9b8..2ff74a5 100644
--- a/include/yaml/yaml_version.h
+++ b/include/yaml/yaml_version.h
@@ -1,3 +1,10 @@
+/**
+ * @file yaml_version.h
+ * @brief Version information.
+ *
+ * Do not include yaml_version.h directly.
+ */
+
 #ifndef YAML_VERSION_H
 #define YAML_VERSION_H
 
@@ -5,15 +12,20 @@
 extern "C" {
 #endif
 
+/**
+ * @brief Get the library version.
+ */
+
 const char *
 yaml_get_version_string(void);
 
+/**
+ * @brief Get the library version numbers.
+ */
+
 void
 yaml_get_version(int *major, int *minor, int *patch);
 
-int
-yaml_check_version(int major, int minor, int patch);
-
 #ifdef __cplusplus
 }
 #endif
-- 
cgit v1.2.1