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.

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