我试图在Doxygen生成的HTML中手动指定图像大小.但是,正如我在文档中看到的那样,只有在使用LaTeX输出时才会发生这种情况.这里有人知道任何解决方法吗？
举个例子,我想做这样的事情:
\image html example.png "Caption" width=10px
谢谢!
我无法弄清楚如何在Ubuntu上安装Doxygen GUI(doxywizard).我在哪里可以得到它？
我已经做了足够的谷歌搜索知道,如果我有类似的东西
class SubObject {
public:
//blah blah blah
};
class Aggregate {
public:
boost::shared_ptr<SubObject> m_ptr;
};
如果我有一个虚拟声明,我可以让Doxygen创建"正确"的协作图
namespace boost { template<class T> class shared_ptr { T *dummy; }; }
在我的头文件中.
我的问题是:如何在我的所有项目和所有标题中使用它,而不必在每个文件中实际包含该行？
当我编写类模板,并且需要对这些类的成员进行完全特化时,Doxygen不会识别专门化 - 它只记录泛型定义,或者(如果只有特化)最后一个定义.这是一个简单的例子:
=== MyClass.hpp ===
#ifndef MYCLASS_HPP
#define MYCLASS_HPP
template<class T> class MyClass{
public:
static void foo();
static const int INT_CONST;
static const T TTYPE_CONST;
};
/* generic definitions */
template<class T>
void MyClass<T>::foo(){
printf("Generic foo\n");
}
template<class T>
const int MyClass<T>::INT_CONST = 5;
/* specialization declarations */
template<> void MyClass<double>::foo();
template<> const int MyClass<double>::INT_CONST;
template<> const double MyClass<double>::TTYPE_CONST;
template<> const char MyClass<char>::TTYPE_CONST;
#endif
=== MyClass.cpp ===
#include "MyClass.hpp"
/* specialization definitions */
template<>
void MyClass<double>::foo(){
printf("Specialized double foo\n"); …我正在使用Doxygen进行C++项目.当我构建html文档时,我收到以下错误:
C:/ Amir/Programming/Eclipse C++/CacheOptimization/src/CacheLruNaiveAlgorithm.cpp:19:
警告:找不到唯一匹配的类成员
void CacheOpt::CacheLruNaiveAlgorithm::init(TierList &tierList, TierMap *tierMap)
可能是这个警告的来源是什么？通常会导致什么？
编辑:
我的Doxyfile
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "Cache Optimization"
PROJECT_NUMBER = 1.0
PROJECT_BRIEF = "Technion & LSI - Industrial Project"
PROJECT_LOGO =
OUTPUT_DIRECTORY = "C:/Amir/Programming/Eclipse C++/CacheOptimization/doc/"
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
ALWAYS_DETAILED_SEC = …我知道Javadoc会编译{@inheritDoc},但Doxygen的方法是什么？
Doxygen配置:
DOT_PATH = ../../../../Applications/Contents/MacOS/Graphviz
HAVE_DOT = YES
SHORT_NAMES = YES
从日志控制台,第一行它会发出警告:
警告:无法在../../../../Applications/Contents/MacOS/Graphviz找到点工具
我尝试了各种组合,但警告并没有消失,虽然它确实生成了图像.
使用9个并行线程生成点图...
运行图形为1/68
sh:dot:命令未找到运行dot的问题:退出代码= 127,command ='dot',arguments ='"/ Users/salilk/Documents/project/DoxygenDocs/html/a00033.dot"-Tpng -o"/ Users/salilk/Documents/project/DoxygenDocs/HTML/a00033.png""
在html目录中已生成.dot文件,但没有.png.
现在,如果我从终端执行相同的命令,则生成.png文件并显示在其.html文件中.
控制台的另一个错误是:
错误:打开地图文件/ Users/salilk/Documents/A2O Collaborate/DoxygenDocs/html/a00032.map以包含在文档中的问题!如果在上次运行失败后安装了Graphviz/dot,请尝试删除输出目录并重新运行doxygen.
这与上述问题有关吗？
我之前在Windows机器上使用过Doxygen并且没有这些错误,我们是否需要针对Mac进行任何特定的配置？
最近我开始在现有项目中编写一些doxygen文档,这个项目已经有很多doxygen评论.
因为我正在学习一点 - 我喜欢迭代编辑和生成文档,因为doc生成很慢 - 3-5分钟.这变得不可行.
我通过删除源代码树中的大多数文件进行管理,因此doxy只发现了我正在编辑的文件,但这确实是一个非常糟糕的解决方案,而不是我经常要做的事情.
有没有办法(例如命令行arg或env变量) - 限制哪些文件/模块用于生成文档 - 所以重建文档可以更快地完成？
我有一个类可能有功能,我想隐藏一个特定的功能.例如
class Test
{
/**
* About Function1
*
* @param[in] arg1 About arg1
* @param[in] arg2 About arg2
*/
public void Function1(int arg1,char arg2);
// Presume same documentation for this function also
public void Function2(int,char);
// Presume same documentation for this function also
public void Function3(int,char);
// Presume same documentation for this function also
public void Function4(int,char);
}
假设我想隐藏说Function2我该怎么做.
现在,在当前场景中,它显示了所有四个功能及其文档.
现在,我在.doxygen规则文件中设置了以下属性:
EXTRACT_ALL = YES
你能告诉我一些可以隐藏的东西吗？
课程记录如下:
/**
* @brief Number representation
*/
class CNumber : public CElem
{
/** @brief Holds true for negative values */
bool neg;
...
但是,代码中记录的变量不会出现在文档中(类简介显示正常......).
我究竟做错了什么？