summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTushar Gohad <tushar.gohad@intel.com>2014-09-03 15:45:38 -0700
committerTushar Gohad <tushar.gohad@intel.com>2014-09-03 15:45:38 -0700
commit1f2f13c9f6f01b1044540371ee7d9d709da7d6a9 (patch)
tree61f046994d0eea580d406b063e4841797eedfd6e
parentcafa07b224255874a80b776fa5574971fbaabca3 (diff)
downloadliberasurecode-1f2f13c9f6f01b1044540371ee7d9d709da7d6a9.tar.gz
Constrain Doxygen to just the frontend/backend API headers
Signed-off-by: Tushar Gohad <tushar.gohad@intel.com>
-rw-r--r--doc/Doxyfile13
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile
index 11fce98..7a4c36b 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -140,7 +140,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
@@ -242,7 +242,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
@@ -427,7 +427,7 @@ EXTRACT_PACKAGE = NO
# included in the documentation.
# The default value is: NO.
-EXTRACT_STATIC = NO
+EXTRACT_STATIC = YES
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
@@ -460,7 +460,7 @@ EXTRACT_ANON_NSPACES = NO
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
-HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_MEMBERS = YES
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. If set
@@ -751,7 +751,8 @@ WARN_LOGFILE =
# spaces.
# Note: If this tag is empty the current directory is searched.
-INPUT = "../src" "../include"
+INPUT = ../include/erasurecode/erasurecode.h \
+ ../include/erasurecode/erasurecode_backend.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
@@ -973,7 +974,7 @@ USE_HTAGS = NO
# See also: Section \class.
# The default value is: YES.
-VERBATIM_HEADERS = YES
+VERBATIM_HEADERS = NO
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index