Question

我有这个C文件：

/**
 * Blah blah blah.
 *
 * @file   myfile.c
 * @author Carlos Alexandro Becker (author@mail.com)
 *
 * @brief  Some Brief.
 */
#include <jni.h>
#include <stdio.h>
#include "myfile.h"

/**
 * Blah blah blah.
 * @param obj The obj
 * @return True
 */
static bool
something_has_blah (jobject * obj)
{
  return true;
}

void
my_fn (JNIEnv * env, jobject * obj, int number)
{
   // code
}

.h文件：

/**
 * Blah blah blah.
 *
 * @file   myfile.h
 * @author Carlos Alexandro Becker (author@mail.com)
 *
 * @brief  Some Brief.
 */
#ifndef FUNCTIONS_H_BIND_INCLUDED
#define FUNCTIONS_H_BIND_INCLUDED

/**
 * Blah blah blah
 * @param env Java Environment
 * @param obj Obj
 * @param number Number
 */
void my_fn (JNIEnv * env, jobject * obj, int number);

#endif

出于某种原因，Doxygen抱怨这个功能：

error: parameters of member my_fn are not (all) documented (warning treated as error, aborting now)

Doxyfile看起来像：

WARN_AS_ERROR         = YES
WARN_IF_UNDOCUMENTED  = YES
WARN_IF_DOC_ERROR     = YES
WARN_NO_PARAMDOC      = YES
JAVADOC_AUTOBRIEF     = YES
OPTIMIZE_OUTPUT_FOR_C = YES
GENERATE_HTML         = NO
GENERATE_LATEX        = NO

在Doxygen开心的方法文档中我缺少什么？我试图添加一个@return void和其他东西，但没有成功。

顺便说一下，这里是完整的可重现代码：https://github.com/caarlos0/happy-doxygen

Answer 1

正如@altert在评论中所说，问题在于缺乏输出格式。

更改了行

GENERATE_HTML         = YES
GENERATE_LATEX        = YES

到

{{1}}

出于某种原因解决了这个问题。

Doxygen：成员my_function的参数未被（全部）记录

1 个答案: