标签: doxygen

我正在使用doxygen(1.8.6)创建一个降价文本文件的pdf.现在我想在markdown文件的特定阶段获取分页符,我使用了这个链接.

在他们提到的给定链接中,使用'>'表示换行符.但他们没有提到过分页符.是的我也可以使用'>'进行分页,但是我必须在markdown文本文件上写下这个符号5次或更多次,这使得markdown文件看起来很怪异.还有其他方法可以在markdown文件中获取分页符吗？

我有一个功能的以下Doxygen文档:

/**
  @brief Does interesting things

  @param[in]  pfirst The first parameter: a barrel full of monkeys

  @pre
    "pfirst" must have been previously passed through BarrelFiller()
*/

请注意,这pfirst是一个参数,并在前提条件中引用它.

我在这里用引号包围它,因为我想从文本的其余部分中脱颖而出.但是这样做会很好,Doxygen会强调命令,最好将它链接到参数定义.有没有办法做到这一点？

如果只使用默认配置(或其微小的改动)就会发生这种情况会特别好.

是否有关于如何使用Doxygen记录C++模板和模板元函数的指南？

例如:

/// @brief metafunction for generation of a map of message types to
/// their associated callbacks.
/// @tparam Seq the list of message types
template< class Seq >
struct generate_callback_map
{
    typedef typename mpl::transform< Seq
                                   , build_type_signature_pair< mpl::_1 > 
                                   >::type vector_pair_type;
    typedef typename fusion::result_of::as_map< vector_pair_type >::type type;
};

到目前为止,我已经看到了以下建议:

• @tparam 用于记录模板参数.
• @arg 记录模板参数的替代方法.
• @brief 用于描述元功能.

如何记录元函数的"返回类型"？

有没有人对使用Doxygen和C++模板有任何好的建议或个人喜好？

我正在开发一个项目,其中c ++/cli库主要来自ac#application.

有没有办法让c ++/cli中的代码注释在visual studio中对c#intellisence可见？

假设没有,那么记录c ++/cli代码的最佳方法是什么,以便从c#中更容易使用(当然在c ++/cli中)？您对XML评论vs doxygen与其他工具(哪些)的看法是什么？

Doxygen状态的文档,我可以在markdown文件中使用PHP Markdown Extra标题,但两者都没有

# Main Page # {#mainpage}

也不

# Main Page # {#index}

工作,但标签不作为纯文本出现在输出中.这是BTW的第一行.

此外,我无法使用上述标签引用该页面,也无法使用文件名称.

我还有一个main.dox包含\mainpage特殊命令的文件,但我也尝试了以上所有操作,并在它们之前删除了一个斜杠(仅使它只有两个).

我正在使用Doxygen 1.8.2(已下载)和1.8.1.1(来自MacPorts)执行此任务.

那怎么能实现呢？

另外,如何将markdown文件标记为特定语言的一部分？

编辑:我启用了markdown支持,文件出现在引用的页面中.

我的团队C代码指南写道,最好在注释中放置一个'<',如下所示:

#define MAX_PACK_ITEM_NUM 50  /**<  max number of item */

我想知道,这个'<'的实际用途是什么？

我正在尝试使用\citeDoxygen来生成参考书目页面,也是我文本中的参考文献.我的搜索路径中有bibtex和正确的.bib文件.我已经将.bib文件添加到了文件中,CITE_BIB_FILES并使用了正确的BibTex标签.bib.Doxygen正在创建一个参考书目页面,但它是空的.它还在文档文本中创建引文链接,但链接也是空的.知道怎样才能显示引文信息吗？

我想添加自定义(非项目)文件以使用Doxygen生成一些额外的页面.

我(实际上)不确定应该如何命名这些文件以及如何格式化它们的内容.

我想使用Graphviz + Doxygen来生成基于C++代码的类图.这已经成功,因为Doxygen带有本地DOT支持; 但有可能,生成类似UML的输出与相应的访问修饰符(公共,私有等),类方法的返回和参数类型,类似于下图？

我知道线程如何使用doxygen从C++源代码创建UML类图,但它并没有回答这个问题.

我想Doxygen忽略,绕过,而不是搜索我项目的以下目录:

*/.svn/*
*/docs/*
*/Properties/*
*/bin/*

根据Doxygen FAQ:

How can I exclude all test directories from my directory tree?

Simply put an exclude pattern like this in the configuration file:

EXCLUDE_PATTERNS = */test/*

所以,我的Doxygen文件看起来像这样:

# If the value of the INPUT tag contains directories, you can use the 
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
# certain files from those directories. Note that the wildcards are matched 
# against the file with absolute path, …