diff options
| author |  Mark Griffiths <mark@thebespokepixel.com> | 2014-09-04 12:07:07 +0100 |
|---|---|---|
| committer | Mark Griffiths <mark@thebespokepixel.com> | 2014-09-04 12:07:07 +0100 |
| commit | 1b4c85eb6949570a6e44384812cb69c57ef473c7 (patch) | |
| tree | d50d7f76724d9fc0d8ea706cc1b293ef8d3a454b | |
| parent | fb792c60cdfa51da84b820e733ba0e168b7101ab (diff) | |
Fixed Doxygen required version to 1.8.7
Doxygen 1.8.6 and lower do not have the \\htmlonly[block] directive
which fixes a multitude of problems in the rendering of the docs. In
Doxygen 1.8.7 the list of understood HTML entities was greatly
increased. I tested earlier versions and many little issues returned.
| -rw-r--r-- | configure.ac | 2 | ||||
| -rw-r--r-- | doc_src/FORMATTING.md | 7 |
2 files changed, 7 insertions, 2 deletions
diff --git a/configure.ac b/configure.ac index f36e2602..43276ff2 100644 --- a/configure.ac +++ b/configure.ac @@ -146,7 +146,7 @@ AS_IF([test x$local_gettext != xno], # Build/clean the documentation only if Doxygen is available # -doxygen_minimum=1.8 +doxygen_minimum=1.8.7 AC_ARG_WITH( doxygen, diff --git a/doc_src/FORMATTING.md b/doc_src/FORMATTING.md index 382d9aff..4e96a27b 100644 --- a/doc_src/FORMATTING.md +++ b/doc_src/FORMATTING.md @@ -1,6 +1,6 @@ # Formatting guide for fish docs -The fish documentation has been updated to support Doxygen 1.8+, and while the main benefit of this change is extensive Markdown support, the addition of a fish lexicon and syntax filter, combined with semantic markup rules allows for automatic formatting enhancements across the HTML user_docs, the developer docs and the man pages. +The fish documentation has been updated to support Doxygen 1.8.7+, and while the main benefit of this change is extensive Markdown support, the addition of a fish lexicon and syntax filter, combined with semantic markup rules allows for automatic formatting enhancements across the HTML user_docs, the developer docs and the man pages. Initially my motivation was to fix a problem with long options ([Issue #1557](https://github.com/fish-shell/fish-shell/issues/1557) on GitHub), but as I worked on fixing the issue I realised there was an opportunity to simplify, reinforce and clarify the current documentation, hopefully making further contribution easier and cleaner, while allowing the documentation examples to presented more clearly with less author effort. @@ -199,8 +199,13 @@ Some useful Unicode/HTML5 entities: ### Doxygen +- Tested on Ubuntu 14.04 with Doxygen 1.8.8, built from source. - Tested on Mac OS X 10.9 with Homebrew install Doxygen 1.8.7 and 1.8.8. +Doxygen 1.8.6 and lower do not have the \\htmlonly[block] directive which fixes a multitude of problems in the rendering of the docs. In Doxygen 1.8.7 the list of understood HTML entities was greatly increased. I tested earlier versions and many little issues returned. + +As fish ships with pre-built documentation, I don't see this as an issue. + ### Updated Configure/Makefile - Tested on Ubuntu 14.04, CentOS 6.5 and Mac OS X 10.9. |