Doxygen:成员 my_function 的参数未(全部)记录在案
Doxygen: parameters of member my_function are not (all) documented
我有这个 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
正如@altert 在评论中所说,问题是缺少输出格式。
更改了台词
GENERATE_HTML = NO
GENERATE_LATEX = NO
至
GENERATE_HTML = YES
GENERATE_LATEX = YES
出于某种原因解决了这个问题。
我有这个 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
正如@altert 在评论中所说,问题是缺少输出格式。
更改了台词
GENERATE_HTML = NO
GENERATE_LATEX = NO
至
GENERATE_HTML = YES
GENERATE_LATEX = YES
出于某种原因解决了这个问题。