1
Ich habe diese C Datei:Doxygen: Parameter der Mitglieds my_function sind nicht (alle) dokumentiert
/**
* Blah blah blah.
*
* @file myfile.c
* @author Carlos Alexandro Becker ([email protected])
*
* @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
}
Und die .h Datei:
/**
* Blah blah blah.
*
* @file myfile.h
* @author Carlos Alexandro Becker ([email protected])
*
* @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
Aus irgendeinem Grund wird Doxygen über diese Funktion beschweren :
error: parameters of member my_fn are not (all) documented (warning treated as error, aborting now)
Die Doxyfile wie folgt aussieht:
Was fehlt mir in der Dokumentation dieser Methode, um Doxygen glücklich zu machen? Ich habe versucht, eine @return void und andere Sachen hinzuzufügen, aber nichts hat geklappt.
By the way, hier ist der vollständige reproduzierbare Code: https://github.com/caarlos0/happy-doxygen
Huh. Ich frage mich, warum es "Mitglied" heißt. – melpomene
@melpomene yeah, ich bin neu bei doxygen, also habe ich auch keine Ahnung ... – caarlos0
@melpomene Ich habe auch die '.h' Datei hinzugefügt, ich nehme an, die' member' Sache ist deswegen. – caarlos0