| Sam Elliott | b6745d3 | 2020-04-08 21:46:28 +0100 | [diff] [blame^] | 1 | #--------------------------------------------------------------------------- |
| 2 | # Project related configuration options |
| 3 | #--------------------------------------------------------------------------- |
| 4 | |
| 5 | PROJECT_NAME = "Software APIs" |
| 6 | PROJECT_LOGO = "$(SRCTREE_TOP)/doc/opentitan-logo.png" |
| 7 | |
| 8 | OUTPUT_DIRECTORY = "$(DOXYGEN_OUT)" |
| 9 | ALLOW_UNICODE_NAMES = YES |
| 10 | |
| 11 | JAVADOC_AUTOBRIEF = YES |
| 12 | |
| 13 | STRIP_FROM_INC_PATH = "$(SRCTREE_TOP)" |
| 14 | |
| 15 | TAB_SIZE = 2 |
| 16 | |
| 17 | OPTIMIZE_OUTPUT_FOR_C = YES |
| 18 | |
| 19 | # We use .c and .h for C |
| 20 | EXTENSION_MAPPING = h=C c=C |
| 21 | |
| 22 | INLINE_SIMPLE_STRUCTS = YES |
| 23 | |
| 24 | # This doesn't work for enums |
| 25 | TYPEDEF_HIDES_STRUCT = NO |
| 26 | |
| 27 | #--------------------------------------------------------------------------- |
| 28 | # Build related configuration options |
| 29 | #--------------------------------------------------------------------------- |
| 30 | |
| 31 | EXTRACT_ANON_NSPACES = YES |
| 32 | HIDE_IN_BODY_DOCS = YES |
| 33 | INTERNAL_DOCS = NO |
| 34 | CASE_SENSE_NAMES = NO |
| 35 | |
| 36 | FORCE_LOCAL_INCLUDES = NO |
| 37 | STRIP_FROM_INC_PATH = "$(SRCTREE_TOP)" \ |
| 38 | "$(SRCTREE_TOP)/sw/device/lib/base/freestanding" |
| 39 | |
| 40 | GENERATE_TODOLIST = NO |
| 41 | GENERATE_TESTLIST = NO |
| 42 | GENERATE_BUGLIST = NO |
| 43 | |
| 44 | SHOW_USED_FILES = NO |
| 45 | SHOW_NAMESPACES = NO |
| 46 | |
| 47 | FILE_VERSION_FILTER = "git log --format='%h' -1 --" |
| 48 | |
| 49 | LAYOUT_FILE = "$(SRCTREE_TOP)/site/docs/doxygen/layout.xml" |
| 50 | |
| 51 | #--------------------------------------------------------------------------- |
| 52 | # Configuration options related to warning and progress messages |
| 53 | #--------------------------------------------------------------------------- |
| 54 | |
| 55 | QUIET = YES |
| 56 | WARN_LOGFILE = "$(DOXYGEN_OUT)/doxygen_warnings.log" |
| 57 | |
| 58 | #--------------------------------------------------------------------------- |
| 59 | # Configuration options related to the input files |
| 60 | #--------------------------------------------------------------------------- |
| 61 | |
| 62 | # Absolute path using $(SRCTREE_TOP) |
| 63 | INPUT = "$(SRCTREE_TOP)/sw" \ |
| 64 | "$(SRCTREE_TOP)/site/docs/doxygen/main_page.md" |
| 65 | |
| 66 | USE_MDFILE_AS_MAINPAGE = "$(SRCTREE_TOP)/site/docs/doxygen/main_page.md" |
| 67 | |
| 68 | FILE_PATTERNS = *.h \ |
| 69 | *.c \ |
| 70 | *.cc |
| 71 | |
| 72 | RECURSIVE = YES |
| 73 | |
| 74 | # Absolute paths using $(SRCTREE_TOP) |
| 75 | EXCLUDE = "$(SRCTREE_TOP)/sw/vendor" \ |
| 76 | "$(SRCTREE_TOP)/sw/device/benchmarks" \ |
| 77 | "$(SRCTREE_TOP)/sw/host/vendor" |
| 78 | |
| 79 | EXCLUDE_SYMLINKS = YES |
| 80 | |
| 81 | # Absolute path using $(SRCTREE_TOP) |
| 82 | IMAGE_PATH = "$(SRCTREE_TOP)/site/docs/doxygen" |
| 83 | |
| 84 | #--------------------------------------------------------------------------- |
| 85 | # Configuration options related to source browsing |
| 86 | #--------------------------------------------------------------------------- |
| 87 | |
| 88 | SOURCE_BROWSER = YES |
| 89 | STRIP_CODE_COMMENTS = NO |
| 90 | |
| 91 | REFERENCES_LINK_SOURCE = NO |
| 92 | |
| 93 | SOURCE_TOOLTIPS = NO |
| 94 | |
| 95 | #--------------------------------------------------------------------------- |
| 96 | # Configuration options related to the alphabetical class index |
| 97 | #--------------------------------------------------------------------------- |
| 98 | |
| 99 | COLS_IN_ALPHA_INDEX = 2 |
| 100 | |
| 101 | #--------------------------------------------------------------------------- |
| 102 | # Configuration options related to the HTML output |
| 103 | #--------------------------------------------------------------------------- |
| 104 | |
| 105 | GENERATE_HTML = YES |
| 106 | |
| 107 | # Relative to `OUTPUT_DIRECTORY` |
| 108 | HTML_OUTPUT = "public-api/sw/apis" |
| 109 | |
| 110 | # Absolute paths using $(SRCTREE_TOP) |
| 111 | HTML_HEADER = "$(SRCTREE_TOP)/site/docs/doxygen/header.html" |
| 112 | HTML_FOOTER = "$(SRCTREE_TOP)/site/docs/doxygen/footer.html" |
| 113 | |
| 114 | HTML_COLORSTYLE_HUE = 271 |
| 115 | |
| 116 | HTML_TIMESTAMP = NO |
| 117 | |
| 118 | GENERATE_DOCSET = NO |
| 119 | GENERATE_HTMLHELP = NO |
| 120 | GENERATE_QHP = NO |
| 121 | GENERATE_ECLIPSEHELP = NO |
| 122 | |
| 123 | ENUM_VALUES_PER_LINE = 1 |
| 124 | |
| 125 | SEARCHENGINE = NO |
| 126 | |
| 127 | #--------------------------------------------------------------------------- |
| 128 | # Configuration options related to the LaTeX output |
| 129 | #--------------------------------------------------------------------------- |
| 130 | |
| 131 | GENERATE_LATEX = NO |
| 132 | |
| 133 | #--------------------------------------------------------------------------- |
| 134 | # Configuration options related to the RTF output |
| 135 | #--------------------------------------------------------------------------- |
| 136 | |
| 137 | GENERATE_RTF = NO |
| 138 | |
| 139 | #--------------------------------------------------------------------------- |
| 140 | # Configuration options related to the man page output |
| 141 | #--------------------------------------------------------------------------- |
| 142 | |
| 143 | GENERATE_MAN = NO |
| 144 | |
| 145 | #--------------------------------------------------------------------------- |
| 146 | # Configuration options related to the XML output |
| 147 | #--------------------------------------------------------------------------- |
| 148 | |
| 149 | GENERATE_XML = YES |
| 150 | |
| 151 | # Relative to `OUTPUT_DIRECTORY` |
| 152 | XML_OUTPUT = "api-xml" |
| 153 | |
| 154 | XML_PROGRAMLISTING = NO |
| 155 | |
| 156 | #--------------------------------------------------------------------------- |
| 157 | # Configuration options related to the DOCBOOK output |
| 158 | #--------------------------------------------------------------------------- |
| 159 | |
| 160 | GENERATE_DOCBOOK = NO |
| 161 | |
| 162 | #--------------------------------------------------------------------------- |
| 163 | # Configuration options for the AutoGen Definitions output |
| 164 | #--------------------------------------------------------------------------- |
| 165 | |
| 166 | GENERATE_AUTOGEN_DEF = NO |
| 167 | |
| 168 | #--------------------------------------------------------------------------- |
| 169 | # Configuration options related to the Perl module output |
| 170 | #--------------------------------------------------------------------------- |
| 171 | |
| 172 | GENERATE_PERLMOD = NO |
| 173 | |
| 174 | #--------------------------------------------------------------------------- |
| 175 | # Configuration options related to the preprocessor |
| 176 | #--------------------------------------------------------------------------- |
| 177 | |
| 178 | INCLUDE_PATH = "$(SRCTREE_TOP)/sw/device/lib/base/freestanding" |
| 179 | |
| 180 | INCLUDE_FILE_PATTERNS = *.h |
| 181 | |
| 182 | PREDEFINED = |
| 183 | EXPAND_AS_DEFINED = |
| 184 | |
| 185 | SKIP_FUNCTION_MACROS = YES |
| 186 | |
| 187 | #--------------------------------------------------------------------------- |
| 188 | # Configuration options related to the dot tool |
| 189 | #--------------------------------------------------------------------------- |
| 190 | |
| 191 | CLASS_DIAGRAMS = NO |
| 192 | |
| 193 | HAVE_DOT = NO |
| 194 | CLASS_GRAPH = NO |
| 195 | COLLABORATION_GRAPH = NO |
| 196 | GROUP_GRAPHS = NO |
| 197 | INCLUDE_GRAPH = NO |
| 198 | INCLUDED_BY_GRAPH = NO |
| 199 | GRAPHICAL_HIERARCHY = NO |
| 200 | DIRECTORY_GRAPH = NO |
