如何用doxygen生成文档

在代码中加入文档 这个是第一步，也是最重要的一步，直接影响着文档的优与劣.Doxygen是一个比较成熟的工具了，它有非常详细且专业的文档.文档是写在代码当中的，以注释块的形式，为了区分代码中的正常注释，访文档需要用特殊的形式的注释块来呈现.Doxygen支持多种文档注释块：Javadoc形式的：/** * ... */QT形式的/*！ * ... */或者，这样/// /// ... ///或者，这样//！ //！ .. //！后二种有点非主流，不建议使用.推荐使用前面二种.当然，配置了某些特殊的选项也可以使用其他格式.当Doxygen看到这种形式的注释块时就会把它从代码中抽取出来，生成HTML形式的文档.为了让文档更且有可读性，表达出更多的信息，Doxygen就定义了很多的命令，常用的有：\file 告诉Doxygen这是某个文件的文档块\enum 给一个enum类型加文档\struct 给一个结构体加文档\param 函数的参数\return 函数的返回值\see 交叉参考\brief 简介，用于概览时控制在一行以内，可以空一行，然后写更多的详细的内容\code \endcode 示例代码\note 注意事项\par HTML中的 需要注意的是，这些命令也可以用javadoc格式的来写如@file, @enum, @return等.但建议用标准格式，因为\只需要敲一下，而@需要敲二下，另外就是并不是所有的命令都支持javadoc格式.还有就是如果想写交叉引用可以在前面加个#就会自动转为相应的链接，直接上个例子就都明白了：/** * \brief Obtain current list of path * * \param [out] paths a pointer to an array of strings * \param [out] count indicating the count of path. * * \note * This function will allocate memory for path array. So caller must free the array, but should not free each item. * * \return #API_RESULT_CODE indicating whether this call success or failed. * * \par Sample code: * \code * char **path = NULL; * int count = 0; * test_get_paths(&path, &count); * // use the path * free(path); * path = NULL; * \endcode */ int test_get_paths(char ***paths, int *count)；配置Doxygen Doxygen需要一个配置文件来告诉Doxygen一些选项.配置文件就是一个纯文本文件，格式跟标准的Linux配置文件一样：一行一个配置项，前面是配置项的名字，然后是等号后面就是配置项的值了.以#开头都是注释.Doxygen的选项特别的多，不可以手动的去写，通常都是编辑一个现有的模板，这个模板可以用Doxygen来生成：doxygen -g config-filename PROJECT_NAME 项目的名字，一定要改成你项目的名字PROJECT_NUMBER 编号，通常使用项目的版本号OUTPUT_DIRECTORY 文档输出存放目录，建议修改，比如docPROJECT_BRIEF 项目的描述，会出现文档每一页的上面，控制在一行80字符内（越短越好）EXTRACT_*** 打头的选项要仔细读，如果是API文档，则这些全都要设成NO，这样就仅抽取特定文档块内的内容. 其他的选项都可以不改，用默认的就成.生成文档 这步最简单，如果前面都就绪了，仅需要运行命令即可：doxygen config-filename 后，文档就会出现在所指定的输出目录中.doxygen会打印出日志信息.为了保证质量，最好把把的Warning都修正掉.（这跟修正代码的所有编译警告一个道理）.上面例子生成的文档：int test_get_paths(char *** paths, int * count ) Obtain current list of path. Parameters:[out]pathsa pointer to an array of strings[out]countindicating the count of path.Note:This function will allocate memory for path array. So caller must free the array, but should not free each item.Returns:API_RESULT_CODE indicating whether this call success or failed.Sample code:char **path = NULL; int count = 0; test_get_paths(&path, &count); // use the path free(path); path = NULL； 完整示例下载

doxygen生成的文件怎么都是utf-8的

public class CloudLed { boolean m_isOn; Camera m_Camera; public boolean getIsOn() { return m_isOn; } public CloudLed() { m_isOn = false; } public void turnOn() { if(!m_isOn) { m_isOn = true; try {

自动生成word我的工作需要填充大量的格式化的WORD文档,大部

1.如果你只是生成普通的电子文档，不需要编辑的话，那么先扫描，然后将扫描生成的图件导入word即可 2.如果你是要生成能够编辑文字的文档，那么你需要将纸质文档清楚的扫描，也就是扫描的时候分辨率要高，然后在用文字识别软件（如尚书、清华紫光、汉王等等）进行文字识别，将识别的文字导入word，然后再与原纸质文档校对。

为什么会自动生成这样的word文件我打开一个word文件,然后关

1、保存网页在浏览器中访问目标网页，执行菜单“文件”→“另存为”，文件类型选择“网页，全部”。

2、用WPS文字打开html文件执行“文件”→“打开”，文件类型选择“网页文件”或“所有文件”，以打开刚才下载得到的《[征稿八]怎样用WPS制作PDF》html文件。

3、去掉不需要的部分注：表格形式出现的正文，可以选中后执行“表格”→“转换”→“表格转换为文本”去除表格外框。

4、最后另存为WPS文档或WORD文档即可。

doxygen生成索引不全是怎么回事？

项目名称：将在最新的文档首页中显示源码列表：选择要生成文档的源代码或目录，可以有多个文件或目录形成一个列表。

建议使用相对路径，相对于当前目录（也即当前配置文件所在的目录）递归扫描：如果需要对整个源码目录下的所有子目录及文件生成文档，请勾选本项输出目录：设置最终生成的帮助文档的存储路径，建议使用相对路径~

WORD文档排版问题经过复制和粘贴所形成的WORD文档,整篇文章

首先，通过xml模板可以将基本上所有的格式都事先锁定，包括页码和分页，只要你事先预设好就能够通过freemarker实现生成，接下来就是我这个问题了，目录怎么解决，下面是解决思路：1：目录的内容可以根据之前其他的内容一样解决，通过XML模板预先设置好，2：目录的页码已经研究过是不能直接通过xml模板实现动态对应了（至少我没搞定0.0）3：由于不能够一步到位，我采取了在模板中预留了一页空白页，只留了抬头的目录两个字，然后通过查询目录二字进行目录的生成，这个功能也是我刚刚折腾出来的0.0目前还没测试能不能用模板生成目录后再更新目录0.0，不过想想可以直接生成目录应该就不用这么麻烦了，至于word生成后的修改0.0我觉得还是以后再说吧..整体来说应该还算完美解决了，代码我就不在这贴出来了~虽然中间折腾了半天走了半天弯路~讲道理还是用的jacob来实现的。

。