summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Pipping <sebastian@pipping.org>2017-08-19 18:13:35 +0200
committerSebastian Pipping <sebastian@pipping.org>2017-08-19 22:36:35 +0200
commit8dc1e86cfe96011f5c4624c3ddd2ff80ef50b24b (patch)
treeaa7027641d1ad65a5c641344937dd902cc6c8f35
parent175be33aaa6018f90db7831afbde9ab85953debb (diff)
downloadlibexpat-git-8dc1e86cfe96011f5c4624c3ddd2ff80ef50b24b.tar.gz
doxygen: Configure to Expat's needsdoxygen
-rw-r--r--expat/doc/Doxyfile28
-rw-r--r--expat/doc/DoxygenLayout.xml31
-rw-r--r--expat/doc/DoxygenMainpage.txt16
3 files changed, 43 insertions, 32 deletions
diff --git a/expat/doc/Doxyfile b/expat/doc/Doxyfile
index 378c6f56..27f088ee 100644
--- a/expat/doc/Doxyfile
+++ b/expat/doc/Doxyfile
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.
-PROJECT_NAME = "My Project"
+PROJECT_NAME = "libexpat"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
@@ -44,7 +44,7 @@ PROJECT_NUMBER =
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
-PROJECT_BRIEF =
+PROJECT_BRIEF = "XML parser"
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
@@ -150,7 +150,7 @@ INLINE_INHERITED_MEMB = NO
# shortest path that makes the file name unique will be used
# The default value is: YES.
-FULL_PATH_NAMES = YES
+FULL_PATH_NAMES = NO
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
@@ -252,7 +252,7 @@ TCL_SUBST =
# members will be omitted, etc.
# The default value is: NO.
-OPTIMIZE_OUTPUT_FOR_C = NO
+OPTIMIZE_OUTPUT_FOR_C = YES
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
@@ -435,7 +435,7 @@ LOOKUP_CACHE_SIZE = 0
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
-EXTRACT_ALL = NO
+EXTRACT_ALL = YES
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
@@ -544,7 +544,7 @@ HIDE_COMPOUND_REFERENCE= NO
# the files that are included by a file in the documentation of that file.
# The default value is: YES.
-SHOW_INCLUDE_FILES = YES
+SHOW_INCLUDE_FILES = NO
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
@@ -578,7 +578,7 @@ SORT_MEMBER_DOCS = YES
# this will also influence the order of the classes in the class list.
# The default value is: NO.
-SORT_BRIEF_DOCS = NO
+SORT_BRIEF_DOCS = YES
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# (brief and detailed) documentation of class members so that constructors and
@@ -703,7 +703,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
-LAYOUT_FILE =
+LAYOUT_FILE = DoxygenLayout.xml
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
@@ -790,7 +790,9 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
-INPUT =
+INPUT = \
+ DoxygenMainpage.txt \
+ ../lib/expat.h \
# 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
@@ -1459,7 +1461,7 @@ DISABLE_INDEX = NO
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
-GENERATE_TREEVIEW = NO
+GENERATE_TREEVIEW = YES
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation.
@@ -1647,7 +1649,7 @@ EXTRA_SEARCH_MAPPINGS =
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
-GENERATE_LATEX = YES
+GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -2040,7 +2042,7 @@ ENABLE_PREPROCESSING = YES
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-MACRO_EXPANSION = NO
+MACRO_EXPANSION = YES
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and
@@ -2080,7 +2082,7 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-PREDEFINED =
+PREDEFINED = DOXYGEN
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
diff --git a/expat/doc/DoxygenLayout.xml b/expat/doc/DoxygenLayout.xml
index ac353bf8..0f363f99 100644
--- a/expat/doc/DoxygenLayout.xml
+++ b/expat/doc/DoxygenLayout.xml
@@ -2,24 +2,17 @@
<!-- Generated by doxygen 1.8.13 -->
<!-- Navigation index tabs for HTML output -->
<navindex>
- <tab type="mainpage" visible="yes" title=""/>
- <tab type="pages" visible="yes" title="" intro=""/>
- <tab type="modules" visible="yes" title="" intro=""/>
- <tab type="namespaces" visible="yes" title="">
- <tab type="namespacelist" visible="yes" title="" intro=""/>
- <tab type="namespacemembers" visible="yes" title="" intro=""/>
+ <tab type="mainpage" visible="yes" title="Home"/>
+ <tab type="usergroup" title="API">
+ <tab type="user" url="group__parser-creation.html" title="Parser Creation"/>
+ <tab type="user" url="group__parsing.html" title="Parsing"/>
+ <tab type="user" url="group__handler-setting.html" title="Handler Setting"/>
+ <tab type="user" url="group__reporting.html" title="Parse Position and Error Reporting"/>
+ <tab type="user" url="group__misc.html" title="Miscellaneous"/>
</tab>
- <tab type="classes" visible="yes" title="">
- <tab type="classlist" visible="yes" title="" intro=""/>
- <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
- <tab type="hierarchy" visible="yes" title="" intro=""/>
- <tab type="classmembers" visible="yes" title="" intro=""/>
- </tab>
- <tab type="files" visible="yes" title="">
- <tab type="filelist" visible="yes" title="" intro=""/>
- <tab type="globals" visible="yes" title="" intro=""/>
- </tab>
- <tab type="examples" visible="yes" title="" intro=""/>
+ <tab type="filelist" visible="yes" title="Header Files" intro=""/>
+ <tab type="globals" visible="yes" title="" intro=""/>
+ <tab type="classlist" visible="yes" title="Structures" intro=""/>
</navindex>
<!-- Layout definition for a class page -->
@@ -113,13 +106,13 @@
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
<sourcelink visible="yes"/>
<memberdecl>
+ <defines title=""/>
+ <functions title=""/>
<classes visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<constantgroups visible="yes" title=""/>
- <defines title=""/>
<typedefs title=""/>
<enums title=""/>
- <functions title=""/>
<variables title=""/>
<membergroups visible="yes"/>
</memberdecl>
diff --git a/expat/doc/DoxygenMainpage.txt b/expat/doc/DoxygenMainpage.txt
new file mode 100644
index 00000000..736bfbb1
--- /dev/null
+++ b/expat/doc/DoxygenMainpage.txt
@@ -0,0 +1,16 @@
+/*!
+ \mainpage
+
+
+ \section getting-started Getting Started
+ For a tutorials on using Expat as well as articles on Expat, please
+ check out [Expat documentation](https://libexpat.github.io/doc/), instead.
+
+
+ \section Overview
+ For a listing of groups of functions, please see
+ the [API page](usergroup0.html).
+
+ For a *complete* overview of the API, please see
+ the lib/expat.h page.
+*/