Browse Source

doc: Use other doxygen feature to specify mainpage

Previously a special tag was added to README.md to make this the
main page in Doxygen generated docs. When viewing the README on the
GitHub page this tag was not hidden.

After upgrading to Doxygen 1.8.8 (and above) in changeset
219025727d a new Doxygen feature can be
used to specify the main page: Since release 1.8.3 Doxygen has a special
option to set a markdown file as main page. When using this option we
can drop the tag, making the README rendered by GitHub nice to look at.

Fixes: ae66b24369
tags/json-c-0.14-20200419
Alexander Dahl 7 years ago
parent
commit
89747ac758
2 changed files with 3 additions and 4 deletions
  1. +2
    -3
      Doxyfile
  2. +1
    -1
      README.md

+ 2
- 3
Doxyfile View File

@@ -753,8 +753,7 @@ WARN_LOGFILE =
# spaces.
# Note: If this tag is empty the current directory is searched.

INPUT = README.md \
.
INPUT =

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -891,7 +890,7 @@ FILTER_SOURCE_PATTERNS =
# (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 =
USE_MDFILE_AS_MAINPAGE = README.md

#---------------------------------------------------------------------------
# Configuration options related to source browsing


+ 1
- 1
README.md View File

@@ -1,4 +1,4 @@
`json-c` {#mainpage}
`json-c`
========

1. [Overview and Build Status](#overview)


Loading…
Cancel
Save