标签: doxywizard

使用README.md文件作为Doxygen中的主页

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

# Main Page # {#mainpage}
Run Code Online (Sandbox Code Playgroud)

也不

# Main Page # {#index}
Run Code Online (Sandbox Code Playgroud)

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

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

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

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

那怎么能实现呢?

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

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

markdown doxygen doxywizard

48
推荐指数
2
解决办法
3万
查看次数

如何在Ubuntu上安装Doxygen GUI?

我无法弄清楚如何在Ubuntu上安装Doxygen GUI(doxywizard).我在哪里可以得到它?

doxygen doxywizard

15
推荐指数
2
解决办法
4万
查看次数

如何删除 doxygen 中的源路径

我正在使用 doxygen 为我的头文件生成一个 chm 文档。我在删除 chm 中的源(即头文件)的路径时遇到问题。例如,如果我的头文件的路径是 c:\users\dx\Desktop\myprogram,我的路径似乎出现在文件引用中,就在文件列表和文件成员的正下方(即当我点击文件 -> 然后点击我的头文件名我能够看到我的头文件的绝对路径)下面的链接是我面临的问题的屏幕截图。

https://www.dropbox.com/sc/qzodmybui6nxub2/BeAqf7y2jM

如何删除目录引用、头文件引用,如何防止这些路径显示?

我尝试删除 source_browsers、verbatim_headers、strip_from_inc_path 他们都没有工作

提前致谢。

Ps-非常抱歉描述不佳,我希望该链接有助于理解我的问题

doxygen doxywizard

10
推荐指数
1
解决办法
7580
查看次数

如何在Doxygen markdown中创建换行符?

我很难找到解释如何在Doxygen markdown中添加换行符的文档.

我尝试在行尾使用两个空格,我也尝试过单行或双行换行,但这些都不适用于我.

我正在使用Doxygen版本1.8.9.1.

doxygen doxywizard

10
推荐指数
2
解决办法
1万
查看次数

使用doxygen的\ link命令

我有一个外部HTML文件,我希望链接到我的doxygen"相关页面"选项卡或左侧框架.我似乎需要使用\link命令,但我找不到如何使用它或在哪里的好例子.我目前正在使用doxywizard来生成HTML.

那么,\link我将这些内容整合到我的doxygen配置文件中,还是在我以某种方式构建HTML时添加它?

更新

所以我最终不得不做以下事情:

  1. 创建具有以下内容的新页面(docs_main.html):

    /*! \mainpage MY TITLE HERE
     * \section intro_sec External resources
     * <a href="link_to_my_external_page.html">My external page</a>
     */
    
    Run Code Online (Sandbox Code Playgroud)
  2. 在我的doxygen包含文件列表中包含该页面

  3. 重建我的文档

这增加了我的doxygen"主页"以下内容

MY TITLE HERE

My external page (which was a link to that page)
Run Code Online (Sandbox Code Playgroud)

doxygen doxywizard

9
推荐指数
2
解决办法
2万
查看次数

Doxygen输出成员纯粹按照声明的顺序?

哪个Doxygen选项可以完全禁用按类型排序成员(私有/公共/方法/变量),输出成员纯粹基于它们的声明顺序?

doxygen documentation-generation doxywizard

7
推荐指数
1
解决办法
4047
查看次数

Doxygen不会处理main.cpp

所以我是新手使用Doxygen,我能够让它顺利运作.我能够记录我的类和结构,并完美地生成HTML文件.我遇到的问题是它不会解析我的main.cpp文件.所有的类和结构都有自己的.h和.cpp文件,它们处理得很好.如何让Doxygen为main.cpp制作文档?它没有.h文件,因为这是程序开始和结束的地方.我甚至都不知道要把什么放在主文件的.h文件中.我在Windows中使用Doxywizard.

编辑:

我把它放在main中,它会生成一个主页面:

/**
@mainpage

This is a test application.

@author Alex
@date 10/21/2010
@version 1.0
*/
Run Code Online (Sandbox Code Playgroud)

但是在函数原型的文件中,我有这个并且它没有被解析:

/**
@brief Error handler for the PDF writer.

It does nothing. It just has to exist.
*/
void error_handler (HPDF_STATUS   error_no,
                    HPDF_STATUS   detail_no,
                    void         *user_data)
{
}
Run Code Online (Sandbox Code Playgroud)

doxygen mainclass doxywizard

6
推荐指数
1
解决办法
4671
查看次数

Doxygen,doxywizard编码问题

我在Windows XP下工作,我正在使用Doxygen(实际上是Doxywizard)来创建文档.

我有编码问题.在Doxywizard的书签expert->proect->DOXYFILE_ENCODING我写了cp1250(我也尝试过Windows-1250),但它仍然不起作用,我没有得到正确的文本.

我在QtCreator工作.

谢谢你的帮助.

doxygen character-encoding doxywizard

6
推荐指数
1
解决办法
2429
查看次数

生成函数调用图Doxygen + Graphviz

如何使用安装了Graphviz的Doxywizard生成函数调用图?(我知道如何让doxygen为c函数生成调用和调用者图,但它没有帮助)

目前,我已经尝试了以下配置:http://pastebin.com/PjLjwjxU,但我无法在任何地方找到图表(我从未使用过该工具,所以它可能不是技术问题,但更多的是用户问题).

c doxygen graphviz doxywizard call-graph

6
推荐指数
1
解决办法
6681
查看次数

如何获取 Doxygen 文档中的纯文本文件?

我无法在 Doxygen 文档中包含任何文本文件。唯一的例外是README.md我设置为主页的文件。

特别是,我想Changelog.txt在文档中查看该文件。我试图在INPUT字段和字段中显式添加它FILE_PATTERNS,但没有成功。在生成的 HTML 文档中,我无法在文件列表中找到任何内容,也无法进行搜索。

唯一的跟踪位于 Doxygen 的日志文件中:

Preprocessing C:/Source/Changelog.txt...
Parsing file C:/Source/Changelog.txt...
...
Parsing code for file Changelog.txt...
Run Code Online (Sandbox Code Playgroud)

如果我将文件的扩展名从 更改为txtmd该文件将添加到文档中。

text doxygen text-files doxywizard

5
推荐指数
1
解决办法
2916
查看次数

doxygen不从输入过滤器产生输出(doxyqml)

我正在尝试使用doxyqml通过doxygen生成QML文档,但是没有创建文档页面.

根据doxyqml文档,我添加了一个*.qml条目FILE_PATTERNS,并添加*.qml=doxyqmlFILTER_PATTERNS(doxyqml可用,/usr/bin所以只需调用doxyqml命令行就足以启动它).

从doxygen输出我可以看到*.qml文件模式正在工作,因为文件出现在输出的"读取"阶段 - 但不是解析阶段.如果我#define在文件中添加一个或其他非QML语句,那么doxygen输出中会出现doxyqml错误,所以我知道正确调用了doxyqml.

我也知道doxyqml输出是正确的,因为如果我直接用一个qml文件复制调用doxyqml的输出,并将其粘贴到一个*.h文件中,doxygen会为它构建文档.

这几乎就像doxygen只是没有读取doxyqml的输出.有没有其他人有这种经验?我正在使用doxygen 1.8.8和最新的doxyqml代码库(2014年7月7日).

doxygen doxywizard qml

4
推荐指数
1
解决办法
871
查看次数

Doxygen不会为源文件生成文档

第一次在这里使用Doxygen.使用Doxygen向导,我很确定我正在设置所有目录和一切正确但由于某种原因输出的文档只有头文件.我的项目是用C语言编写的,它就像是完全忽略.c源文件而只是从目录中获取.h头文件.

我假设它只是我没有检查我需要的选项之一,或者检查了一个不应该的选项.我的输入FILE_PATTERNS包括.c和.h,以及其他一些,但它仍然不会为.c文件创建文档.

知道为什么这样做吗?我不知道我还能在这里包括哪些内容来帮助你解决我的问题,所以如果你需要我包含其他内容,请告诉我.

更新:我发现一个设置至少显示html输出中的.c文件,但仍然没有源代码文档.我不知道为什么它不能创建源代码文档,但它可以识别并显示其中的所有函数和变量.

Input configuration is as follows:

INPUT                  = "C:/Users/Me/Desktop/ProjectFoler/Project"
INPUT_ENCODING         = UTF-8
FILE_PATTERNS          = *.c \
                         *.cc \
                         *.cxx \
                         *.cpp \
                         *.c++ \
                         *.java \
                         *.ii \
                         *.ixx \
                         *.ipp \
                         *.i++ \
                         *.inl \
                         *.idl \
                         *.ddl \
                         *.odl \
                         *.h \
                         *.hh \
                         *.hxx \
                         *.hpp \
                         *.h++ \
                         *.cs \
                         *.d \
                         *.php \
                         *.php4 \
                         *.php5 \
                         *.phtml \
                         *.inc \
                         *.m \
                         *.markdown \
                         *.md \
                         *.mm \
                         *.dox \
                         *.py …
Run Code Online (Sandbox Code Playgroud)

doxygen doxywizard

3
推荐指数
2
解决办法
1万
查看次数

多个变量的相同注释

我和这个人有同样的问题:

doxygen一次注释多个变量

我已经在线程中尝试了建议的解决方案,就像OP一样,我无法让doxygen对多个变量有相同的注释.有人可以帮忙吗?

谢谢

doxygen doxywizard

2
推荐指数
1
解决办法
1750
查看次数