Doxygen在我的TCL示例中遇到问题

时间:2018-02-21 04:29:22

标签: tcl doxygen

我发现excellent information关于在我的Doxygen输出中引入示例。不幸的是,TCL脚本似乎不适用于@examples命令。

examples page shows up但我包含的脚本的条目有一个水平规则,其中应显示示例代码。 (我可以进入Chrome开发人员的模式并确认此时DIV标记对之间没有任何内容。)

有趣的是,如果我从@example命令中删除文件名中的扩展名但保持内容相同,我可以在示例页面上看到代码。 Doxygen正在处理TCL代码,这使得这个过程失败了。

我希望其他人经历过这种情况,并告诉我我做错了什么或确认Doxygen在TCL示例方面遇到了麻烦。

命令用法:

##@example csv-simple.tcl
# This example demonstrates creating the CSV object instance,
# loading data into it and finally serializing the data to an HTML doc.

csv-simple.tcl :(位于doc / examples文件夹中)

package require ali

set mydata [ali::csv %AUTO% -header f]

$mydata setHeader [list A B C]
$mydata setData [list [list 1 2 3] [list 4 5 6] [list 7 8 9]]

$mydata writeFile "csv-simple.html" [$mydata serialize htmlDoc]

的Doxyfile:     项目路径为{long path}/asl275,其下方包含文件夹doc/imagesdoc/exampleslib

OUTPUT_DIRECTORY = doc
ABBREVIATE_BRIEF = "The $name class" \
                     "The $name widget" \
                     "The $name file" \
                     is \
                     provides \
                     specifies \
                     contains \
                     represents \
                     a \
                     an \
                     the
FULL_PATH_NAMES = NO
JAVADOC_AUTOBRIEF = YES
TAB_SIZE = 3
TCL_SUBST = snit::type=itcl::class \
                     option=variable
TOC_INCLUDE_HEADINGS = 3
WARN_FORMAT = $file @ $line: $text
INPUT                  = doc/markdown \
                     lib
FILE_PATTERNS          = *.tcl \
                     *.vhd \
                     *.vhdl \
                     *.md
RECURSIVE = YES
EXCLUDE = lib/pkgIndex.tcl
EXAMPLE_PATH           = doc/examples
IMAGE_PATH             = doc/images
SOURCE_BROWSER         = YES
INLINE_SOURCE          = YES
GENERATE_TREEVIEW      = YES
GENERATE_LATEX         = NO
ENABLE_PREPROCESSING   = NO
CLASS_DIAGRAMS         = NO

Doxygen配置中的示例路径已正确设置以查找csv-simple.tcl,并且在运行Doxygen GUI(v1.8.14)时未报告任何错误。

其他人可以重现我使用TCL和Doxygen @examples的经验吗?

0 个答案:

没有答案