You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

245 lines
8.9 KiB

  1. # Doxyfile 1.5.3
  2. #---------------------------------------------------------------------------
  3. # Project related configuration options
  4. #---------------------------------------------------------------------------
  5. DOXYFILE_ENCODING = UTF-8
  6. PROJECT_NAME = KiCad PCB EDA Suite
  7. PROJECT_NUMBER =
  8. OUTPUT_DIRECTORY = Documentation/doxygen
  9. CREATE_SUBDIRS = NO
  10. OUTPUT_LANGUAGE = English
  11. BRIEF_MEMBER_DESC = YES
  12. REPEAT_BRIEF = YES
  13. ABBREVIATE_BRIEF =
  14. ALWAYS_DETAILED_SEC = NO
  15. INLINE_INHERITED_MEMB = YES
  16. FULL_PATH_NAMES = NO
  17. STRIP_FROM_PATH =
  18. STRIP_FROM_INC_PATH =
  19. SHORT_NAMES = NO
  20. JAVADOC_AUTOBRIEF = YES
  21. QT_AUTOBRIEF = NO
  22. MULTILINE_CPP_IS_BRIEF = NO
  23. DETAILS_AT_TOP = YES
  24. INHERIT_DOCS = YES
  25. SEPARATE_MEMBER_PAGES = NO
  26. TAB_SIZE = 4
  27. ALIASES =
  28. OPTIMIZE_OUTPUT_FOR_C = NO
  29. OPTIMIZE_OUTPUT_FOR_CPP = YES
  30. OPTIMIZE_OUTPUT_JAVA = NO
  31. BUILTIN_STL_SUPPORT = NO
  32. CPP_CLI_SUPPORT = NO
  33. DISTRIBUTE_GROUP_DOC = NO
  34. SUBGROUPING = YES
  35. #---------------------------------------------------------------------------
  36. # Build related configuration options
  37. #---------------------------------------------------------------------------
  38. EXTRACT_ALL = YES
  39. EXTRACT_PRIVATE = NO
  40. EXTRACT_STATIC = YES
  41. EXTRACT_LOCAL_CLASSES = YES
  42. EXTRACT_LOCAL_METHODS = NO
  43. EXTRACT_ANON_NSPACES = NO
  44. HIDE_UNDOC_MEMBERS = NO
  45. HIDE_UNDOC_CLASSES = NO
  46. HIDE_FRIEND_COMPOUNDS = NO
  47. HIDE_IN_BODY_DOCS = NO
  48. INTERNAL_DOCS = NO
  49. CASE_SENSE_NAMES = YES
  50. HIDE_SCOPE_NAMES = NO
  51. SHOW_INCLUDE_FILES = YES
  52. INLINE_INFO = YES
  53. SORT_MEMBER_DOCS = YES
  54. SORT_BRIEF_DOCS = NO
  55. SORT_BY_SCOPE_NAME = NO
  56. GENERATE_TODOLIST = YES
  57. GENERATE_TESTLIST = YES
  58. GENERATE_BUGLIST = YES
  59. GENERATE_DEPRECATEDLIST= YES
  60. ENABLED_SECTIONS =
  61. MAX_INITIALIZER_LINES = 30
  62. SHOW_USED_FILES = YES
  63. SHOW_DIRECTORIES = YES
  64. FILE_VERSION_FILTER =
  65. #---------------------------------------------------------------------------
  66. # configuration options related to warning and progress messages
  67. #---------------------------------------------------------------------------
  68. QUIET = NO
  69. WARNINGS = YES
  70. WARN_IF_UNDOCUMENTED = YES
  71. WARN_IF_DOC_ERROR = YES
  72. WARN_NO_PARAMDOC = NO
  73. WARN_FORMAT = "$file:$line: $text "
  74. WARN_LOGFILE =
  75. #---------------------------------------------------------------------------
  76. # configuration options related to the input files
  77. #---------------------------------------------------------------------------
  78. INPUT = kicad \
  79. pcbnew \
  80. cvpcb \
  81. eeschema \
  82. 3d-viewer \
  83. common \
  84. gerbview \
  85. share \
  86. include \
  87. polygon
  88. INPUT_ENCODING = UTF-8
  89. FILE_PATTERNS = *.h \
  90. *.cpp
  91. RECURSIVE = YES
  92. EXCLUDE =
  93. EXCLUDE_SYMLINKS = NO
  94. EXCLUDE_PATTERNS =
  95. EXCLUDE_SYMBOLS =
  96. EXAMPLE_PATH =
  97. EXAMPLE_PATTERNS =
  98. EXAMPLE_RECURSIVE = NO
  99. IMAGE_PATH =
  100. INPUT_FILTER =
  101. FILTER_PATTERNS =
  102. FILTER_SOURCE_FILES = NO
  103. #---------------------------------------------------------------------------
  104. # configuration options related to source browsing
  105. #---------------------------------------------------------------------------
  106. SOURCE_BROWSER = YES
  107. INLINE_SOURCES = YES
  108. STRIP_CODE_COMMENTS = YES
  109. REFERENCED_BY_RELATION = YES
  110. REFERENCES_RELATION = YES
  111. REFERENCES_LINK_SOURCE = YES
  112. USE_HTAGS = NO
  113. VERBATIM_HEADERS = YES
  114. #---------------------------------------------------------------------------
  115. # configuration options related to the alphabetical class index
  116. #---------------------------------------------------------------------------
  117. ALPHABETICAL_INDEX = YES
  118. COLS_IN_ALPHA_INDEX = 5
  119. IGNORE_PREFIX =
  120. #---------------------------------------------------------------------------
  121. # configuration options related to the HTML output
  122. #---------------------------------------------------------------------------
  123. GENERATE_HTML = YES
  124. HTML_OUTPUT = doxygen
  125. HTML_FILE_EXTENSION = .html
  126. HTML_HEADER =
  127. HTML_FOOTER =
  128. HTML_STYLESHEET =
  129. HTML_ALIGN_MEMBERS = YES
  130. GENERATE_HTMLHELP = NO
  131. HTML_DYNAMIC_SECTIONS = NO
  132. CHM_FILE =
  133. HHC_LOCATION =
  134. GENERATE_CHI = NO
  135. BINARY_TOC = NO
  136. TOC_EXPAND = NO
  137. DISABLE_INDEX = NO
  138. ENUM_VALUES_PER_LINE = 4
  139. GENERATE_TREEVIEW = YES
  140. TREEVIEW_WIDTH = 250
  141. #---------------------------------------------------------------------------
  142. # configuration options related to the LaTeX output
  143. #---------------------------------------------------------------------------
  144. GENERATE_LATEX = NO
  145. LATEX_OUTPUT = latex
  146. LATEX_CMD_NAME = latex
  147. MAKEINDEX_CMD_NAME = makeindex
  148. COMPACT_LATEX = NO
  149. PAPER_TYPE = a4wide
  150. EXTRA_PACKAGES =
  151. LATEX_HEADER =
  152. PDF_HYPERLINKS = NO
  153. USE_PDFLATEX = NO
  154. LATEX_BATCHMODE = NO
  155. LATEX_HIDE_INDICES = NO
  156. #---------------------------------------------------------------------------
  157. # configuration options related to the RTF output
  158. #---------------------------------------------------------------------------
  159. GENERATE_RTF = NO
  160. RTF_OUTPUT = rtf
  161. COMPACT_RTF = NO
  162. RTF_HYPERLINKS = NO
  163. RTF_STYLESHEET_FILE =
  164. RTF_EXTENSIONS_FILE =
  165. #---------------------------------------------------------------------------
  166. # configuration options related to the man page output
  167. #---------------------------------------------------------------------------
  168. GENERATE_MAN = NO
  169. MAN_OUTPUT = man
  170. MAN_EXTENSION = .3
  171. MAN_LINKS = NO
  172. #---------------------------------------------------------------------------
  173. # configuration options related to the XML output
  174. #---------------------------------------------------------------------------
  175. GENERATE_XML = NO
  176. XML_OUTPUT = xml
  177. XML_SCHEMA =
  178. XML_DTD =
  179. XML_PROGRAMLISTING = YES
  180. #---------------------------------------------------------------------------
  181. # configuration options for the AutoGen Definitions output
  182. #---------------------------------------------------------------------------
  183. GENERATE_AUTOGEN_DEF = NO
  184. #---------------------------------------------------------------------------
  185. # configuration options related to the Perl module output
  186. #---------------------------------------------------------------------------
  187. GENERATE_PERLMOD = NO
  188. PERLMOD_LATEX = NO
  189. PERLMOD_PRETTY = YES
  190. PERLMOD_MAKEVAR_PREFIX =
  191. #---------------------------------------------------------------------------
  192. # Configuration options related to the preprocessor
  193. #---------------------------------------------------------------------------
  194. ENABLE_PREPROCESSING = YES
  195. MACRO_EXPANSION = NO
  196. EXPAND_ONLY_PREDEF = NO
  197. SEARCH_INCLUDES = YES
  198. INCLUDE_PATH = include \
  199. pcbnew \
  200. eeschema \
  201. gerbview
  202. INCLUDE_FILE_PATTERNS = *.h
  203. PREDEFINED =
  204. EXPAND_AS_DEFINED =
  205. SKIP_FUNCTION_MACROS = YES
  206. #---------------------------------------------------------------------------
  207. # Configuration::additions related to external references
  208. #---------------------------------------------------------------------------
  209. TAGFILES =
  210. GENERATE_TAGFILE =
  211. ALLEXTERNALS = NO
  212. EXTERNAL_GROUPS = YES
  213. PERL_PATH = /usr/bin/perl
  214. #---------------------------------------------------------------------------
  215. # Configuration options related to the dot tool
  216. #---------------------------------------------------------------------------
  217. CLASS_DIAGRAMS = YES
  218. MSCGEN_PATH =
  219. HIDE_UNDOC_RELATIONS = YES
  220. HAVE_DOT = NO
  221. CLASS_GRAPH = YES
  222. COLLABORATION_GRAPH = YES
  223. GROUP_GRAPHS = YES
  224. UML_LOOK = NO
  225. TEMPLATE_RELATIONS = YES
  226. INCLUDE_GRAPH = YES
  227. INCLUDED_BY_GRAPH = YES
  228. CALL_GRAPH = NO
  229. CALLER_GRAPH = NO
  230. GRAPHICAL_HIERARCHY = YES
  231. DIRECTORY_GRAPH = YES
  232. DOT_IMAGE_FORMAT = png
  233. DOT_PATH =
  234. DOTFILE_DIRS =
  235. DOT_GRAPH_MAX_NODES = 50
  236. MAX_DOT_GRAPH_DEPTH = 0
  237. DOT_TRANSPARENT = NO
  238. DOT_MULTI_TARGETS = NO
  239. GENERATE_LEGEND = YES
  240. DOT_CLEANUP = YES
  241. #---------------------------------------------------------------------------
  242. # Configuration::additions related to the search engine
  243. #---------------------------------------------------------------------------
  244. SEARCHENGINE = NO