分享
 
 
 

DoxyGen文档之六

王朝vc·作者佚名  2006-01-08
窄屏简体版  字體: |||超大  

第三章:Lists列表

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.

 
 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
2023年上半年GDP全球前十五强
 百态   2023-10-24
美众议院议长启动对拜登的弹劾调查
 百态   2023-09-13
上海、济南、武汉等多地出现不明坠落物
 探索   2023-09-06
印度或要将国名改为“巴拉特”
 百态   2023-09-06
男子为女友送行,买票不登机被捕
 百态   2023-08-20
手机地震预警功能怎么开?
 干货   2023-08-06
女子4年卖2套房花700多万做美容:不但没变美脸,面部还出现变形
 百态   2023-08-04
住户一楼被水淹 还冲来8头猪
 百态   2023-07-31
女子体内爬出大量瓜子状活虫
 百态   2023-07-25
地球连续35年收到神秘规律性信号,网友:不要回答!
 探索   2023-07-21
全球镓价格本周大涨27%
 探索   2023-07-09
钱都流向了那些不缺钱的人,苦都留给了能吃苦的人
 探索   2023-07-02
倩女手游刀客魅者强控制(强混乱强眩晕强睡眠)和对应控制抗性的关系
 百态   2020-08-20
美国5月9日最新疫情:美国确诊人数突破131万
 百态   2020-05-09
荷兰政府宣布将集体辞职
 干货   2020-04-30
倩女幽魂手游师徒任务情义春秋猜成语答案逍遥观:鹏程万里
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案神机营:射石饮羽
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案昆仑山:拔刀相助
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案天工阁:鬼斧神工
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案丝路古道:单枪匹马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:与虎谋皮
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:李代桃僵
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:指鹿为马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:小鸟依人
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:千金买邻
 干货   2019-11-12
 
推荐阅读
 
 
 
>>返回首頁<<
 
靜靜地坐在廢墟上,四周的荒凉一望無際,忽然覺得,淒涼也很美
© 2005- 王朝網路 版權所有