在\ file上下文中使用Doxygen \ xrefitem,\ todo等命令,没有成员上下文(名称空间/类/过程)

时间:2014-04-15 14:01:51

标签: doxygen

我正在记录Tcl源代码,其中一些文件是通过源代码执行的,因此其中唯一的Doxygen上下文是\ file(顶部)(没有命名空间,proc,类等) 。)

在这些" \ file" -only上下文中,当我使用\ xrefitem命令(或任何派生词,ex。\ todo \ bug等)时,Doxygen不会提取信息。

有没有办法说服'用氧来提取这些?

任何其他可以使这项工作的技巧?

-------------- [2014-05-16编辑下方] --------------

根据要求,这是添加了doxygen标签后的小型源代码文件的示例。正确选取文件的标题,但完全忽略\ todo项。

## \file pre_vsi.tcl
# \verbatim
# -----------------------------------------------------------------------------
# HEADER $Id$
# HEADER_MSG    Project
# HEADER_MSG    Tool Version
# HEADER_MSG    Copyright Notice
# HEADER_MSG
# -----------------------------------------------------------------------------
# DESCRIPTION:
# * This script runs Verdi Signoff-LP.
# -----------------------------------------------------------------------------
# \endverbatim

# Example items that might be best applied in the pre script

if { $TEV(lp_mode) == "NETLIST" || $TEV(lp_mode) == "PGNETLIST"} {
  ## \todo "This is a todo item"
  #
  # and a paragraph for a todo item
  #
  infer_source
  redirect $RPT(basename).infer_source { infer_source }
  # create_source <blah>
  # remove_source <blah>
}

if {0} {
  # example items that might be best applied in the pre-script
  configure_lp_tab
  waive_lp
}

# -----------------------------------------------------------------------------
# End Of File
# -----------------------------------------------------------------------------

0 个答案:

没有答案