Chinaunix首页 | 论坛 | 博客
  • 博客访问: 255896
  • 博文数量: 65
  • 博客积分: 2599
  • 博客等级: 少校
  • 技术积分: 710
  • 用 户 组: 普通用户
  • 注册时间: 2010-05-04 10:49
文章分类

全部博文(65)

文章存档

2015年(4)

2013年(2)

2012年(4)

2011年(51)

2010年(4)

分类: LINUX

2011-11-17 17:40:23

配置
提前安装一个graphviz,可以生成调用关系图。
创建configure file,这里可以使用doxywizard图形化工具.
设置:
    INPUT: 工程的根目录
    FILE_PATTERNS:文件的正则表达式
    RECURSIVE: YES,递归解析
    SOURCE_BROWSER: YES,cross-reference功能
    ......
    有很多,所以使用doxywizard比较合适,毕竟只是一个工具,
    会使用就行.
    详细的配置选项:~dimitri/doxygen/config.html
我的配置文件:
  1. #---------------------------------------------------------------------------
  2. # Project related configuration options
  3. #---------------------------------------------------------------------------
  4. DOXYFILE_ENCODING = UTF-8
  5. PROJECT_NAME = doxy-test
  6. PROJECT_NUMBER = 1.0.0
  7. OUTPUT_DIRECTORY = /home/sli60/Documents/doxygen/doc
  8. CREATE_SUBDIRS = NO
  9. OUTPUT_LANGUAGE = Chinese
  10. BRIEF_MEMBER_DESC = YES
  11. REPEAT_BRIEF = YES
  12. ABBREVIATE_BRIEF = "The $name class" \
  13.                          "The $name widget" \
  14.                          "The $name file" \
  15.                          is \
  16.                          provides \
  17.                          specifies \
  18.                          contains \
  19.                          represents \
  20.                          a \
  21.                          an \
  22.                          the
  23. ALWAYS_DETAILED_SEC = NO
  24. INLINE_INHERITED_MEMB = NO
  25. FULL_PATH_NAMES = YES
  26. STRIP_FROM_PATH =
  27. STRIP_FROM_INC_PATH =
  28. SHORT_NAMES = NO
  29. JAVADOC_AUTOBRIEF = NO
  30. QT_AUTOBRIEF = NO
  31. MULTILINE_CPP_IS_BRIEF = NO
  32. INHERIT_DOCS = YES
  33. SEPARATE_MEMBER_PAGES = NO
  34. TAB_SIZE = 8
  35. ALIASES =
  36. OPTIMIZE_OUTPUT_FOR_C = YES
  37. OPTIMIZE_OUTPUT_JAVA = NO
  38. OPTIMIZE_FOR_FORTRAN = NO
  39. OPTIMIZE_OUTPUT_VHDL = NO
  40. EXTENSION_MAPPING =
  41. BUILTIN_STL_SUPPORT = NO
  42. CPP_CLI_SUPPORT = NO
  43. SIP_SUPPORT = NO
  44. IDL_PROPERTY_SUPPORT = YES
  45. DISTRIBUTE_GROUP_DOC = NO
  46. SUBGROUPING = YES
  47. TYPEDEF_HIDES_STRUCT = NO
  48. SYMBOL_CACHE_SIZE = 0

  49. #---------------------------------------------------------------------------
  50. # Build related configuration options
  51. #---------------------------------------------------------------------------
  52. EXTRACT_ALL = YES
  53. EXTRACT_PRIVATE = NO
  54. EXTRACT_STATIC = NO
  55. EXTRACT_LOCAL_CLASSES = YES
  56. EXTRACT_LOCAL_METHODS = NO
  57. EXTRACT_ANON_NSPACES = NO
  58. HIDE_UNDOC_MEMBERS = NO
  59. HIDE_UNDOC_CLASSES = NO
  60. HIDE_FRIEND_COMPOUNDS = NO
  61. HIDE_IN_BODY_DOCS = NO
  62. INTERNAL_DOCS = NO
  63. CASE_SENSE_NAMES = NO
  64. HIDE_SCOPE_NAMES = YES
  65. SHOW_INCLUDE_FILES = YES
  66. FORCE_LOCAL_INCLUDES = NO
  67. INLINE_INFO = YES
  68. SORT_MEMBER_DOCS = YES
  69. SORT_BRIEF_DOCS = NO
  70. SORT_MEMBERS_CTORS_1ST = NO
  71. SORT_GROUP_NAMES = NO
  72. SORT_BY_SCOPE_NAME = NO
  73. GENERATE_TODOLIST = YES
  74. GENERATE_TESTLIST = YES
  75. GENERATE_BUGLIST = YES
  76. GENERATE_DEPRECATEDLIST= YES
  77. ENABLED_SECTIONS =
  78. MAX_INITIALIZER_LINES = 30
  79. SHOW_USED_FILES = YES
  80. SHOW_DIRECTORIES = NO
  81. SHOW_FILES = YES
  82. SHOW_NAMESPACES = YES
  83. FILE_VERSION_FILTER =
  84. LAYOUT_FILE =

  85. #---------------------------------------------------------------------------
  86. # configuration options related to warning and progress messages
  87. #---------------------------------------------------------------------------
  88. QUIET = NO
  89. WARNINGS = YES
  90. WARN_IF_UNDOCUMENTED = YES
  91. WARN_IF_DOC_ERROR = YES
  92. WARN_NO_PARAMDOC = NO
  93. WARN_FORMAT = "$file:$line: $text"
  94. WARN_LOGFILE =

  95. #---------------------------------------------------------------------------
  96. # configuration options related to the input files
  97. #---------------------------------------------------------------------------
  98. INPUT = /home/sli60/Documents/doxygen/test
  99. INPUT_ENCODING = UTF-8
  100. FILE_PATTERNS = *.c \
  101.                          *.cc \
  102.                          *.cxx \
  103.                          *.cpp \
  104.                          *.c++ \
  105.                          *.d \
  106.                          *.java \
  107.                          *.ii \
  108.                          *.ixx \
  109.                          *.ipp \
  110.                          *.i++ \
  111.                          *.inl \
  112.                          *.h \
  113.                          *.hh \
  114.                          *.hxx \
  115.                          *.hpp \
  116.                          *.h++ \
  117.                          *.idl \
  118.                          *.odl \
  119.                          *.cs \
  120.                          *.php \
  121.                          *.php3 \
  122.                          *.inc \
  123.                          *.m \
  124.                          *.mm \
  125.                          *.dox \
  126.                          *.py \
  127.                          *.f90 \
  128.                          *.f \
  129.                          *.vhd \
  130.                          *.vhdl
  131. RECURSIVE = YES
  132. EXCLUDE =
  133. EXCLUDE_SYMLINKS = NO
  134. EXCLUDE_PATTERNS =
  135. EXCLUDE_SYMBOLS =
  136. EXAMPLE_PATH =
  137. EXAMPLE_PATTERNS = *
  138. EXAMPLE_RECURSIVE = NO
  139. IMAGE_PATH =
  140. INPUT_FILTER =
  141. FILTER_PATTERNS =
  142. FILTER_SOURCE_FILES = NO

  143. #---------------------------------------------------------------------------
  144. # configuration options related to source browsing
  145. #---------------------------------------------------------------------------
  146. SOURCE_BROWSER = YES
  147. INLINE_SOURCES = NO
  148. STRIP_CODE_COMMENTS = YES
  149. REFERENCED_BY_RELATION = NO
  150. REFERENCES_RELATION = NO
  151. REFERENCES_LINK_SOURCE = YES
  152. USE_HTAGS = NO
  153. VERBATIM_HEADERS = YES

  154. #---------------------------------------------------------------------------
  155. # configuration options related to the alphabetical class index
  156. #---------------------------------------------------------------------------
  157. ALPHABETICAL_INDEX = YES
  158. COLS_IN_ALPHA_INDEX = 5
  159. IGNORE_PREFIX =

  160. #---------------------------------------------------------------------------
  161. # configuration options related to the HTML output
  162. #---------------------------------------------------------------------------
  163. GENERATE_HTML = YES
  164. HTML_OUTPUT = html
  165. HTML_FILE_EXTENSION = .html
  166. HTML_HEADER =
  167. HTML_FOOTER =
  168. HTML_STYLESHEET =
  169. HTML_COLORSTYLE_HUE = 220
  170. HTML_COLORSTYLE_SAT = 100
  171. HTML_COLORSTYLE_GAMMA = 80
  172. HTML_TIMESTAMP = YES
  173. HTML_ALIGN_MEMBERS = YES
  174. HTML_DYNAMIC_SECTIONS = NO
  175. GENERATE_DOCSET = NO
  176. DOCSET_FEEDNAME = "Doxygen generated docs"
  177. DOCSET_BUNDLE_ID = org.doxygen.Project
  178. DOCSET_PUBLISHER_ID = org.doxygen.Publisher
  179. DOCSET_PUBLISHER_NAME = Publisher
  180. GENERATE_HTMLHELP = NO
  181. CHM_FILE =
  182. HHC_LOCATION =
  183. GENERATE_CHI = NO
  184. CHM_INDEX_ENCODING =
  185. BINARY_TOC = NO
  186. TOC_EXPAND = NO
  187. GENERATE_QHP = NO
  188. QCH_FILE =
  189. QHP_NAMESPACE = org.doxygen.Project
  190. QHP_VIRTUAL_FOLDER = doc
  191. QHP_CUST_FILTER_NAME =
  192. QHP_CUST_FILTER_ATTRS =
  193. QHP_SECT_FILTER_ATTRS =
  194. QHG_LOCATION =
  195. GENERATE_ECLIPSEHELP = NO
  196. ECLIPSE_DOC_ID = org.doxygen.Project
  197. DISABLE_INDEX = NO
  198. ENUM_VALUES_PER_LINE = 4
  199. GENERATE_TREEVIEW = YES
  200. USE_INLINE_TREES = NO
  201. TREEVIEW_WIDTH = 250
  202. EXT_LINKS_IN_WINDOW = NO
  203. FORMULA_FONTSIZE = 10
  204. FORMULA_TRANSPARENT = YES
  205. SEARCHENGINE = YES
  206. SERVER_BASED_SEARCH = NO

  207. #---------------------------------------------------------------------------
  208. # configuration options related to the LaTeX output
  209. #---------------------------------------------------------------------------
  210. GENERATE_LATEX = YES
  211. LATEX_OUTPUT = latex
  212. LATEX_CMD_NAME = latex
  213. MAKEINDEX_CMD_NAME = makeindex
  214. COMPACT_LATEX = NO
  215. PAPER_TYPE = a4wide
  216. EXTRA_PACKAGES =
  217. LATEX_HEADER =
  218. PDF_HYPERLINKS = YES
  219. USE_PDFLATEX = YES
  220. LATEX_BATCHMODE = NO
  221. LATEX_HIDE_INDICES = NO
  222. LATEX_SOURCE_CODE = NO

  223. #---------------------------------------------------------------------------
  224. # configuration options related to the RTF output
  225. #---------------------------------------------------------------------------
  226. GENERATE_RTF = NO
  227. RTF_OUTPUT = rtf
  228. COMPACT_RTF = NO
  229. RTF_HYPERLINKS = NO
  230. RTF_STYLESHEET_FILE =
  231. RTF_EXTENSIONS_FILE =

  232. #---------------------------------------------------------------------------
  233. # configuration options related to the man page output
  234. #---------------------------------------------------------------------------
  235. GENERATE_MAN = NO
  236. MAN_OUTPUT = man
  237. MAN_EXTENSION = .3
  238. MAN_LINKS = NO

  239. #---------------------------------------------------------------------------
  240. # configuration options related to the XML output
  241. #---------------------------------------------------------------------------
  242. GENERATE_XML = NO
  243. XML_OUTPUT = xml
  244. XML_SCHEMA =
  245. XML_DTD =
  246. XML_PROGRAMLISTING = YES

  247. #---------------------------------------------------------------------------
  248. # configuration options for the AutoGen Definitions output
  249. #---------------------------------------------------------------------------
  250. GENERATE_AUTOGEN_DEF = NO

  251. #---------------------------------------------------------------------------
  252. # configuration options related to the Perl module output
  253. #---------------------------------------------------------------------------
  254. GENERATE_PERLMOD = NO
  255. PERLMOD_LATEX = NO
  256. PERLMOD_PRETTY = YES
  257. PERLMOD_MAKEVAR_PREFIX =

  258. #---------------------------------------------------------------------------
  259. # Configuration options related to the preprocessor
  260. #---------------------------------------------------------------------------
  261. ENABLE_PREPROCESSING = YES
  262. MACRO_EXPANSION = NO
  263. EXPAND_ONLY_PREDEF = NO
  264. SEARCH_INCLUDES = YES
  265. INCLUDE_PATH =
  266. INCLUDE_FILE_PATTERNS =
  267. PREDEFINED =
  268. EXPAND_AS_DEFINED =
  269. SKIP_FUNCTION_MACROS = YES

  270. #---------------------------------------------------------------------------
  271. # Configuration::additions related to external references
  272. #---------------------------------------------------------------------------
  273. TAGFILES =
  274. GENERATE_TAGFILE =
  275. ALLEXTERNALS = NO
  276. EXTERNAL_GROUPS = YES
  277. PERL_PATH = /usr/bin/perl

  278. #---------------------------------------------------------------------------
  279. # Configuration options related to the dot tool
  280. #---------------------------------------------------------------------------
  281. CLASS_DIAGRAMS = NO
  282. MSCGEN_PATH =
  283. HIDE_UNDOC_RELATIONS = YES
  284. HAVE_DOT = YES
  285. DOT_NUM_THREADS = 0
  286. DOT_FONTNAME = FreeSans.ttf
  287. DOT_FONTSIZE = 10
  288. DOT_FONTPATH =
  289. CLASS_GRAPH = YES
  290. COLLABORATION_GRAPH = YES
  291. GROUP_GRAPHS = YES
  292. UML_LOOK = NO
  293. TEMPLATE_RELATIONS = NO
  294. INCLUDE_GRAPH = YES
  295. INCLUDED_BY_GRAPH = YES
  296. CALL_GRAPH = NO
  297. CALLER_GRAPH = NO
  298. GRAPHICAL_HIERARCHY = YES
  299. DIRECTORY_GRAPH = YES
  300. DOT_IMAGE_FORMAT = png
  301. DOT_PATH =
  302. DOTFILE_DIRS =
  303. DOT_GRAPH_MAX_NODES = 50
  304. MAX_DOT_GRAPH_DEPTH = 0
  305. DOT_TRANSPARENT = NO
  306. DOT_MULTI_TARGETS = NO
  307. GENERATE_LEGEND = YES
  308. DOT_CLEANUP = YES


阅读(1181) | 评论(0) | 转发(0) |
0

上一篇:Doxygen----安装

下一篇:注释说明

给主人留下些什么吧!~~