summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Makefile.am5
-rw-r--r--doxygen.cfg.in10
-rw-r--r--include/plist/plist.h2
3 files changed, 14 insertions, 3 deletions
diff --git a/Makefile.am b/Makefile.am
index 7da967d..f44a6bc 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -25,4 +25,7 @@ docs/html: $(top_builddir)/doxygen.cfg $(top_srcdir)/include/plist/*.h
25 rm -rf docs/html 25 rm -rf docs/html
26 doxygen doxygen.cfg 26 doxygen doxygen.cfg
27 27
28docs: doxygen.cfg docs/html 28docs/README.doxygen.md: README.md
29 awk '/\#\# Table of Contents/{while(getline && $$0 != ""){}{print "[TOC]"}}1' README.md > $@
30
31docs: doxygen.cfg docs/README.doxygen.md docs/html
diff --git a/doxygen.cfg.in b/doxygen.cfg.in
index 8c77b8f..7aa54e8 100644
--- a/doxygen.cfg.in
+++ b/doxygen.cfg.in
@@ -521,7 +521,8 @@ WARN_LOGFILE =
521# directories like "/usr/src/myproject". Separate the files or directories 521# directories like "/usr/src/myproject". Separate the files or directories
522# with spaces. 522# with spaces.
523 523
524INPUT = include/plist/plist.h 524INPUT = include/plist/plist.h \
525 docs/README.doxygen.md
525 526
526# This tag can be used to specify the character encoding of the source files 527# This tag can be used to specify the character encoding of the source files
527# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 528# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -625,6 +626,13 @@ FILTER_PATTERNS =
625 626
626FILTER_SOURCE_FILES = NO 627FILTER_SOURCE_FILES = NO
627 628
629# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
630# is part of the input, its contents will be placed on the main page
631# (index.html). This can be useful if you have a project on for instance GitHub
632# and want to reuse the introduction page also for the doxygen output.
633
634USE_MDFILE_AS_MAINPAGE = docs/README.doxygen.md
635
628#--------------------------------------------------------------------------- 636#---------------------------------------------------------------------------
629# configuration options related to source browsing 637# configuration options related to source browsing
630#--------------------------------------------------------------------------- 638#---------------------------------------------------------------------------
diff --git a/include/plist/plist.h b/include/plist/plist.h
index 426e34f..46aca16 100644
--- a/include/plist/plist.h
+++ b/include/plist/plist.h
@@ -90,7 +90,7 @@ extern "C"
90#include <stdio.h> 90#include <stdio.h>
91 91
92 /** 92 /**
93 * \mainpage libplist : A library to handle Apple Property Lists 93 * libplist : A library to handle Apple Property Lists
94 * \defgroup PublicAPI Public libplist API 94 * \defgroup PublicAPI Public libplist API
95 */ 95 */
96 /*@{*/ 96 /*@{*/