你怎么能像Git那样忽略Doxygen的文件.git/info/exclude？
Doxygen根据第三方代码为我生成文档,例如Email -component和我的Git -repo,我不想要.我需要将文件保存在原来的位置.
好吧,我正在创建一个脚本,使用Doxygen为我的项目自动生成文档,这似乎是一个很棒的工具.
我不清楚的是,如果用户可以使用指定直接参数,例如项目名称,项目描述等,通过设置它们除了命令:
doxygen -g "parameter modification here"
doxygen Doxyfile
任何提示赞赏!
有谁知道如何在Eclipse CDT中编辑用于Doxygen评论的样式？
换句话说,键入/**并enter在函数之前按下一行就会产生类似于:
/**
*
* @param one
* @param two
* @return
*/
Foo(int one, int two);
我希望它能给我一些类似的东西:
/**********************************************************************/
///
/// \param one
/// \param two
/// \return
/***********************************************************************/
Foo(int one, int two);
此外,再加上一个,如果任何人知道如何把它绑定到键盘快捷键(如alt- shift- j为Eclipse JDT).
此外,仅供参考,Eclipse CDT支持Doxygen的事实现在似乎是一个基于谷歌的鲜为人知的事实.详情请见此处.通过在"C/C++常规"选项卡中选择"启用项目特定设置"并选择"Doxygen",可以在项目属性下启用Doxygen.我的CDT版本是7.0.1,但我认为这在5.0中可用.
最后,首选项中代码模板下的注释部分无法根据我的测试完成此操作.
编辑: 见这里.似乎评论样式是硬编码的.如果有人发现,我很想知道.我想模板现在是最好的,除非Javadoc风格适合你.
Doxygen中\ param [out]和\ return有什么区别？它们似乎都记录了函数的输出/返回.差异是由于void函数没有返回值而只是param[out]有效吗？
我有一个项目,我正在使用Doxygen来生成文档.这些类的文档很好,但我也有一些函数,我在main()中使用它来创建对象等.我也想将这些函数放入我的文档中,但我还没有想到如何做到这一点.有什么建议？
我正在使用Eclipse CDT编写C++代码.在StackOverflow上阅读了关于是否将doxygen文档放在头文件或实现文件中的几个讨论,似乎大多数开发人员都赞成在头文件中添加doxygen注释(当然,这绝不是一个共识).但是,如果我在我的头文件中放入doxygen注释,当我将鼠标指针悬停在注释方法/成员的实例上时,我无法让Eclipse显示这些注释.有没有办法让Eclipse在Eclipse的悬停提示中使用我的头文件中的Doxygen文档？
我在Preferences> C/C++> Editor中将"Documentation tool comments Workspace default"设置为"Doxygen".
我在Ubuntu 11.04上使用Eclipse 3.6.2和CDT 7.0.2.
我遇到了Doxygen识别命名空间和模块的问题.我认为问题围绕着是\addtogroup在命名空间内还是在命名空间之外.
/*!
* \addtogroup Records
* @{
*/
//! Generic record interfaces and implementations
namespace Records
{
//! Describes the record interface
class Interface;
} // End namespace Records
/*! @} End of Doxygen Groups*/
//! Generic record interfaces and implementations
namespace Records
{
/*!
* \addtogroup Records
* @{
*/
//! Describes the record interface
class Interface;
/*! @} End of Doxygen Groups*/
} // End namespace Records
我希望它namespace Records出现在Doxygen Namespaces …
c++ doxygen namespaces documentation-generation doxygen-addtogroup
如果你有一个公共函数可能抛出一个异常,它使用其他(私有或公共)辅助函数也可以抛出异常,我认为你应该记录公共函数可以抛出的异常,这包括辅助函数抛出的异常.
像这样(使用Doxygen):
/**
* @throw Exception ...
* @throw ExceptionThrownByHelper ...
* @throw ExceptionThrownByHelpersHelper ...
*/
void theFunction()
{
helperWhichMayThrowException();
}
并且helperWhichMayThrowException()还调用可能抛出异常的其他函数.
为此,您可以:
theFunction()调用并查找该函数所引发的异常.这是很多工作,当您向助手添加异常时,您可能忘记在某处记录异常.theFunction()并转换它们,这样您就可以确定只抛出您指定的异常.但那么为什么要使用例外？我想使用选项4,但我还没有找到一个好的解决方案,也许它可以用Doxygen吗？或许我只是想要记录多少???
编辑:也许它不是很清楚,但我正在寻找一种简单的方法来记录所有异常(最好使用Doxygen)函数可能抛出而无需手动检查所有辅助函数.一种简单的方法包括"不记录所有异常"或"捕获并转换所有异常theFunction()"
我正在研究共享的Matlab代码,我们希望在本地网络中共享生成的文档作为可搜索的HTML文档.
我知道以下生成文档的方法:
Mathworks不支持所有可能性.所有可能性都需要我提到自己的函数参数.他们没有分析代码,Doxygen是为Java做的:
//! an object representation of the advertisement package sent by the beacon
private AdvertisementPackage advertisementPackage;
我听说过Matlab的publish()函数,但我从未在上述意义上看到过它.
问题:Mathworks生成Matlab HTML文档的方法是什么.代码本身可以分析吗？我可以使用提供给Matlab输入分析器的信息吗？请在评论中提及您的个人偏好.
例:
%% Input parser
p = inputParser;
addRequired(p, 'x', @isnumeric);
validationFcn = @(x) (isnumeric(x) && isscalar(x));
addRequired(p, 'fftSize', validationFcn);
addRequired(p, 'fftShift', validationFcn);
validationFcn = @(x) (isa(x, 'function_handle'));
addRequired(p, 'analysisWindowHandle', validationFcn);
parse(p, x, fftSize, fftShift, analysisWindowHandle);