DoxyGen文档之六

原创 2003年12月28日 12:26:00
 

第三章:Lists列表<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

Doxygen有很多方法来创建项目列表

Using dashes 使用短横杠

在每个行的开始处以“-”打头,以下缩进对齐,列表每项也以“-”打头,下面是个例子

  /*!

   *  A list of events:

   *    - mouse events

   *         -# mouse move event

   *         -# mouse click event/n

   *            More info about the click event.

   *         -# mouse double click event

   *    - keyboard events

   *         -# key down event

   *         -# key up event

   *

   *  More text here.

   */

这样就会生成一个事件列表

·mouse events

1.     mouse move event

2.     mouse click event
More info about the click event.

3.     mouse double click event

·keyboard events

1.     key down event

2.     key up event

More text here.

如果你一直使用tabs,那么要检查配置configuration文件中的TAB_SIZE设置是正确的。

使用“.”可以结束一个list,开始一个新的paragraph,必须于需要对应的“-”对齐。

下面是个例子:

/**

 * Text before the list

 * - list item 1

 *   - sub item 1

 *     - sub sub item 1

 *     - sub sub item 2

 *     .

 *     The dot above ends the sub sub item list.

 *     More text for the first sub item

 *   .

 *   The dot above ends the first sub item.

 *   More text for the first list item

 *   - sub item 2

 *   - sub item 3

 * - list item 2

 * .

 * More text in the same paragraph.

 *

 * More text in a new paragraph.

 */

Using HTML commands 使用HTML命令

如果你喜欢可以考虑在文档块中使用HTML命令。这样可能更自然一些。下面有个例子

   

注意:在此不需要对齐

Using /arg or @li

For compatibility with the Troll Tech's internal documentation tool and with KDoc, doxygen has two commands that can be used to create simple unnested lists.

See /arg and /li for more info.

如何用doxygen生成文档

Doxygen是一款基于源代码生成文档的工具,类似于Java中的javadoc. 概念:文档和注释的区别 文档(Documentation) 是给代码的使用者准备的,或者是更高一级的开发...
  • hitlion2008
  • hitlion2008
  • 2013年03月07日 21:05
  • 8450

使用doxygen生成注释文档——visual studio

前期准备:代码注释。 这里介绍两个方法: 一.安装插件 1. 安装GhostDoc插件。(建议设置快捷键为shift+Alt+j) 2. 回到vs界面规范注释规则。 Tools->GhostDoc->...
  • index_cqq
  • index_cqq
  • 2016年03月22日 16:48
  • 2339

使用Doxygen生成全中文的chm帮助文档

下载和安装 Doxygen到 Doxygen 官网 下载最新的Doxygen安装程序,然后安装。这个软件包包括了一个GUI界面的前端工具,可以帮助我们方便创建Doxygen配置文件和生成目标文档。下...
  • xzytl60937234
  • xzytl60937234
  • 2017年04月22日 15:55
  • 798

用doxygen生成中英文帮助

来源:http://www.opencv.org.cn/forum/viewtopic.php?f=1&t=2635#p9188 用doxygen生成中英文帮助由 chai2010 于 2008-02...
  • hitxiaya
  • hitxiaya
  • 2010年11月26日 13:52
  • 765

doxygen生成word文档

doxygen生成rtf/word使用小心得2009-07-26 19:53       硕士毕业要写个技术文档,蒙了,真麻。怎么也都不行,后来老师给指了条路:使用doxygen。      网上有许...
  • jiabin_007
  • jiabin_007
  • 2010年01月19日 17:37
  • 1512

用 Doxygen 自动生成文档

              用 Doxygen 自动生成文档             Horin|贺勤        Email: horin153@msn.com        Blog: http...
  • horin153
  • horin153
  • 2007年04月30日 15:09
  • 6403

Doxygen生成注释文档

概述:  Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Do...
  • tuwenqi2013
  • tuwenqi2013
  • 2017年04月11日 13:27
  • 1096

利用doxygen生成python文档

On and off I have been developing a little Python module to provide KP-ABE and CP-ABE functionality ...
  • carolzhang8406
  • carolzhang8406
  • 2015年11月09日 14:22
  • 1566

Doxygen自动文档生成工具在Eclipse中的集成及使用举例

你有为软件编写说明文档的苦恼吗?当别人甩给你一个庞大的系统,让你根据里面的代码注释理解后写出一份完整的开发文档,你会怎么办?一个个的看代码然后耗时N天来写吗?这既是一份苦差事也极其耗时,有没有更好的办...
  • lanxuezaipiao
  • lanxuezaipiao
  • 2014年02月16日 17:57
  • 4131

Doxygen代码注释规定和生产文档说明

        Doxygen是一个程序的文档产生工具,可将程序中的特点注释转换成为说明文件。安装与初始化    请到http://www.stack.nl/~dimitri/doxygen/doxy...
  • hsz8250
  • hsz8250
  • 2006年11月24日 14:00
  • 5987
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:DoxyGen文档之六
举报原因:
原因补充:

(最多只允许输入30个字)