Doxygen:如果代码片段具有Objective-C接口,则剥离类级文档

时间:2013-12-06 13:12:01

标签: objective-c doxygen

我正在记录this class,但Appledoc或Doxygen没有太多运气。 。对于这个问题,我想关注Doxygen问题。

Doxygen将规定(忽略)类级别介绍 - 我的意思是在接口上方发生的所有位,如果接口中的代码片段也包含接口或协议。 。 。为了正确记录这个类,我们真的需要这些片段。

有没有办法让doxygen将这些代码段作为片段和普通片段处理,而不是去掉课程概述?

我尝试使用一些~~~~~~栅栏符号,但这不起作用。

以下是ended up looking like

1 个答案:

答案 0 :(得分:0)

有两种方法可以解决这个问题:

使用以下标记告诉Doxygen代码片段如下:

@code
@endcode

另一种选择是使用@include指令,并设置一个示例文件夹,以便将这些包含为独立文件

在此之前,我使用缩进代码块的标记式语法。为了实现这个目的,我必须用反斜杠来逃避以下符号:'@','<'和'>' 。 。从技术上讲这是一个错误,因为doxygen应该将缩进视为代码块。 。 。这已经与Doxygen团队一起记录。