标签: doxygen

有没有人尝试在Lazy C++源文件中嵌入Doxygen评论？任何问题？生成头文件/源文件后,Doxygen注释在哪里？

Doxygen似乎对Objective-C类别进行了特殊处理,我想知道其他人是否能够成功解决它.我想doxygen将类中的所有类别记录为单独的实体,而不管是否记录了基类.

如果我将doxygen标记添加到未记录的基类上的类别 - 比如NSString,那么doxygen 会将类列表中的类别及其方法列为单独的实体.

/**
 *   @category NSString(Foo)
 *   @brief A sample category on NSString
 */
 @interface NSString(Foo)
 @end

结果在类列表中记录的实体NSString(Foo).

但是,以下示例不会:

/**
 *    @category CCFMyCustomClass(Foo)
 *    @brief A category on a documented base class
 */
@interface CCFMyCustomClass(Foo)
@end

相反,在后一种情况下,CCFMyCustomClass(Foo)上的所有方法都包含在CCFMyCustomClass的文档中 - 基类.

以下虽然经常被引用,但似乎没有帮助解决这个问题:

• Doxygen和Objective-C类别

• http://www.duckrowing.com/2010/03/18/documenting-objective-c-with-doxygen-part-i/

我需要一个别名来标记命令行代码,设置在带有白色文本的黑色背景上,如下所示:

@cmd
C:\temp>echo Hello, world!
Hello, world!

C:\temp>
@endcmd

普通的doxygen的别名不能做到这一点(多,嵌套"\ TEMP"),但@code与@verbatim能.但是,我不能使用它们,因为它们被格式化为带有黑色文本的白色背景,因此用自定义CSS覆盖pre.fragment类是不正确的.

有任何想法吗？

UPD:评论显示我的英语有多糟糕......

好吧,再试一次.常规doxygen的功能如HTML和XML的工作方式如下所示:

    cpp file                       doxygen produced index.html
/**
@mainpage main               |  
<pre>                        | <pre>C:&gt;echo Hello, world! 
C:\temp>echo Hello, world!   | Hello, world!</pre>  
Hello, world!                |
                             |
C:\temp>                     | <pre>C:&gt;</pre>
</pre>                       |
*/                           |

在日志中:

/tmp/index.h:3: warning: Found unknown command `\temp'
/tmp/index.h:6: warning: Found unknown command `\temp'

"代码"和"逐字"的工作方式不同!感到不同:

  cpp file                       doxygen produced index.html
/**
@mainpage main               |
@verbatim                    | <div class="fragment">
C:\temp>echo Hello, world! …

正如Do URL页面永久保留的那样,doxygen中的URL 不是永久性的.

那么,你如何从外部网站/ doc链接doxygen中的深层内容(例如:特定函数)？

(目前,暗示用户使用家中的搜索框似乎是一个充分的解决方法)

如何在Qt创建器中注释C++函数,以便当我将鼠标悬停在对该函数的函数调用上时,我可能会将文档视为工具提示.

就像我们这样做/**换行Eclipse自动创建一个注释块我在Qt创建者中寻找相同的内容,请指教.

我想doxygen文档生成器根本不生成任何LaTeX文件.HTML对我来说已经足够了.是否可以配置doxygen.ini这样做？

我有一个我自己无法解决的问题.请帮忙.

我(有条件地):

/** @mainpage A
@subpage B
*/

/** @page B 
@subpage C
*/

/** @page C */

Doxygen使树在根级别显示所有页面.

+ A/
| --- B/
| ------ C
| --- B < - 想要隐藏
| --- C < - 想要隐藏

但我只需要顶部(A这里和嵌套的B&C)可见,即应该相应地组织@subpage标签.

我还尝试在DoxygenLayout.xml中将visible设置为'no'.但它隐藏了所有页面,只剩下"文件"和"类".

Thanx提前.

我看到大多数Doxygen文档用于评论c ++函数,看起来类似于

/// a description of the function or method followed with comments, like so
/// @return true=success, false=error
/// @param[in] bar blah blah
/// @param[out] baz blah blah
/// @param[out] quux blah blah
/// @param[out] quuux blah blah
/// @param[out] quuuux blah blah
static bool foo_one( int *bar, int *baz, int *quux, int *quuux, int *quuuux );

或xml等价物(粗略)

/// a description of the function or method, followed by
/// <returns>true=success, false=error</returns>
/// <param name=bar>blah blah</param>
/// <param name=baz>blah blah</param> …

我有一个项目,我有大量的条件定义,使跨平台开发更容易.但是我在说服Doxygen提取所有定义时遇到了问题,因为它只会选择那些只发生在评估中的定义.

例如,在下面的代码片段中,Doxygen将记录TARGET_X86_64但不记录TARGET_ARM64.

#if defined(_M_ARM64) || defined(__arm64__) || defined(__aarch64__)
/** Build target is ARM64 if defined. */
#define TARGET_ARM64
#else
/** Build target is x86_64 if defined. */
#define TARGET_X86_64
#endif

启用EXTRACT_ALL没有帮助,并且禁用预处理会导致Doxygen根本不记录任何内容.如何获取doxygen来提取两种情况的文档？

我正在尝试使用Doxygen和MikTex（也经过Tex Live测试）从源文件生成PDF，但没有成功。这是一个示例文件，我正在尝试从中生成文档：

/**
 *  @defgroup Example examplegroup
 *  @{ */

/**
 *  @brief Example function
 *  @param[in] e example var */
void exampleFunction( int e )
{
        (void)e;
}

/** @} */

当我尝试运行latex / make.bat生成PDF时，出现错误：

//...

("C:\Program Files\MiKTeX 2.9\tex/latex/caption\ltcaption.sty"))
("C:\Program Files\MiKTeX 2.9\tex/latex/etoc\etoc.sty")
No file refman.aux.
("C:\Program Files\MiKTeX 2.9\tex/latex/base\ts1cmr.fd")
("C:\Program Files\MiKTeX 2.9\tex/latex/psnfss\t1phv.fd")
("C:\Program Files\MiKTeX 2.9\tex/context/base\supp-pdf.mkii"
[Loading MPS to PDF converter (version 2006.09.02).]
) ("C:\Program Files\MiKTeX 2.9\tex/latex/oberdiek\epstopdf-base.sty"
("C:\Program Files\MiKTeX 2.9\tex/latex/oberdiek\grfext.sty"))
*geometry* driver: auto-detecting
*geometry* detected driver: pdftex
("C:\Program Files\MiKTeX 2.9\tex/latex/hyperref\nameref.sty"
("C:\Program Files\MiKTeX …