changeset 6:6ffab5e7d760

misc: add Doxyfile
author David Demelier <markand@malikania.fr>
date Thu, 29 Oct 2020 19:57:35 +0100
parents 956a8f2f5950
children 4a166914a61f
files .hgignore Doxyfile
diffstat 2 files changed, 40 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/.hgignore	Thu Oct 29 19:57:10 2020 +0100
+++ b/.hgignore	Thu Oct 29 19:57:35 2020 +0100
@@ -25,3 +25,6 @@
 ^test/test-resize$
 ^test/test-shrink$
 ^test/test-sub$
+
+# Doxygen stuff.
+^doxygen$
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Doxyfile	Thu Oct 29 19:57:35 2020 +0100
@@ -0,0 +1,37 @@
+#
+# Doxyfile -- generate API documentation for libbuf
+#
+# Copyright (c) 2013-2020 David Demelier <markand@malikania.fr>
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+DOXYFILE_ENCODING      = UTF-8
+PROJECT_NAME           = "libbuf"
+PROJECT_NUMBER         = "1.0.0-dev"
+PROJECT_BRIEF          = "Minimalist dynamic string library for C99"
+PROJECT_LOGO           =
+OUTPUT_DIRECTORY       = doxygen
+ALLOW_UNICODE_NAMES    = YES
+STRIP_FROM_PATH        = ./
+TAB_SIZE               = 8
+OPTIMIZE_OUTPUT_FOR_C  = YES
+AUTOLINK_SUPPORT       = NO
+QUIET                  = YES
+WARNINGS               = YES
+INPUT                  = buf.h
+INPUT_ENCODING         = UTF-8
+RECURSIVE              = NO
+GENERATE_LATEX         = NO
+GENERATE_MAN           = NO
+MAX_INITIALIZER_LINES  = 0