diff options
| author |  Nikias Bassen | 2024-02-21 01:01:00 +0100 |
|---|---|---|
| committer | Nikias Bassen | 2024-02-21 01:01:00 +0100 |
| commit | 86c3ef2de8b0b4e2af246410c42cbf03788dd589 (patch) | |
| tree | c75b11f304c2f8d59aa66e88d2a62b379040353d /doxygen.cfg.in | |
| parent | 3ca4f1427e2201be0fce450e7788a4e3499786a8 (diff) | |
| download | libplist-86c3ef2de8b0b4e2af246410c42cbf03788dd589.tar.gz libplist-86c3ef2de8b0b4e2af246410c42cbf03788dd589.tar.bz2 | |
docs: Use README.md to generate mainpage with doxygen
Actually we are using a slightly modified one that removes the
`Table of Contents` section and replaces it with the doxygen-compatible
`[TOC]` to auto-generate a TOC that has working links.
Diffstat (limited to 'doxygen.cfg.in')
| -rw-r--r-- | doxygen.cfg.in | 10 |
1 files changed, 9 insertions, 1 deletions
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 = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = include/plist/plist.h +INPUT = include/plist/plist.h \ + docs/README.doxygen.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -625,6 +626,13 @@ FILTER_PATTERNS = FILTER_SOURCE_FILES = NO +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = docs/README.doxygen.md + #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- |