Changeset 172

Timestamp:

05/21/06 10:58:32 (7 years ago)

Author:

xi

Message:

Add doxygen support.

Location:

libyaml/trunk

Files:

• Makefile.am (modified) (1 diff)
• configure.ac (modified) (1 diff)
• doc (added)
• doc/doxygen.cfg (added)
• include/Makefile.am (modified) (1 diff)
• include/yaml/yaml.h (modified) (1 diff)
• include/yaml/yaml_version.h (modified) (2 diffs)
• src/version.c (modified) (1 diff)
• tests/Makefile.am (modified) (1 diff)
• tests/test-version.c (modified) (2 diffs)

libyaml/trunk/Makefile.am

@@ -3 +3 @@
 
 SUBDIRS = include src . tests
+
+EXTRA_DIST = doc/doxygen.cfg
+
+maintainer-clean-local:
+        -rm -f aclocal.m4 config.h.in configure config/*
+        -find ${builddir} -name Makefile.in -exec rm -f '{}' ';'
+
+.PHONY: bootstrap
+bootstrap: maintainer-clean
+        ./bootstrap
+

libyaml/trunk/configure.ac

@@ -56 +56 @@
 AC_PROG_LIBTOOL
 
+AC_CHECK_PROG(DOXYGEN, [doxygen], [true], [false])
+AM_CONDITIONAL(DOXYGEN, [test "$DOXYGEN" = true])
+
 # Checks for header files.
 AC_HEADER_STDC

libyaml/trunk/include/Makefile.am

@@ -1 @@
-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

libyaml/trunk/include/yaml/yaml.h

@@ +1 @@
+/**
+ * @file yaml.h
+ * @brief Public interface for libyaml.
+ * 
+ * Include the header file with
+ * @code
+ * #include <yaml/yaml.h>
+ * @endcode
+ */
 
 #ifndef YAML_H

libyaml/trunk/include/yaml/yaml_version.h

@@ +1 @@
+/**
+ * @file yaml_version.h
+ * @brief Version information.
+ *
+ * Do not include yaml_version.h directly.
+ */
+
 #ifndef YAML_VERSION_H
 #define YAML_VERSION_H
@@ -6 +13 @@
 #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

libyaml/trunk/src/version.c

@@ -20 +20 @@
 }
 
-int
-yaml_check_version(int major, int minor, int patch)
-{
-    return (major == YAML_VERSION_MAJOR
-            && minor == YAML_VERSION_MINOR
-            && patch >= YAML_VERSION_PATCH);
-}
-

libyaml/trunk/tests/Makefile.am

@@ -1 +1 @@
 AM_CPPFLAGS = -I$(top_srcdir)/include
-LDADD = $(top_srcdir)/src/libyaml.la
+LDADD = $(top_builddir)/src/libyaml.la
 TESTS = test-version
 check_PROGRAMS = test-version

libyaml/trunk/tests/test-version.c

@@ -8 +8 @@
 main(void)
 {
-    int major, minor, patch;
+    int major = -1;
+    int minor = -1;
+    int patch = -1;
     char buf[64];
 
@@ -14 +16 @@
     sprintf(buf, "%d.%d.%d", major, minor, patch);
     assert(strcmp(buf, yaml_get_version_string()) == 0);
-    assert(yaml_check_version(major+1, minor, patch) == 0);
-    assert(yaml_check_version(major, minor+1, patch) == 0);
-    assert(yaml_check_version(major, minor, patch+1) == 1);
-    assert(yaml_check_version(major, minor, patch) == 1);
-    assert(yaml_check_version(major, minor, patch-1) == 0);
 
     return 0;