doxygen warning with nested function

Question

I have doxygen documentation for a nested function.

Doxygen links the documentation for the inner function to the outer function. Therefore doxygen throws this warnings

fileA.cpp:10: warning: argument 'A' of command @param is not found in the argument list of A::test(void)
fileA.cpp:10: warning: argument 'B' of command @param is not found in the argument list of A::test(void)
fileA.cpp:10: warning: found documented return type for A::test that does not return anything

I have tried the special command ef and movement of the comment into the inner function. But this didn't fixed the warning. The only thing that works is if I delete or oopthe documentation for the inner function, but this is not what I want.

Is there a good solution for this task or is this just not a task for doxygen as doxygen generates documentation for a api and gets confused if you document a inner function ?

This are my sources:

fileA.h

#ifndef _FILE_A_H
#define _FILE_A_H

#include 

class A{
private:
   void test(void);
};
#endif

fileA.cpp

#include "fileA.h"

/*******************************************************************************
 * @brief Test
 ******************************************************************************/
void A::test(void)
{
   /*******************************************************************************
    * @brief Compares the value of two objects
    *
    * @param[in] A Value A
    * @param[in] B Value B
    *
    * @return true if A > B, otherwise false
    ******************************************************************************/
   auto compare = [] (const int A,const int B)
   {
      if(A>B){
         return true;
      }
      return false;
   };

   int A = 1;
   int B = 2;
   
   compare(A,B);
}

Doxyfile used with doxygen 1.9.5

# Difference with default Doxyfile 1.9.5 (87846a24ba5d96a548e5e1a377c2ff078a77dd77)
SHORT_NAMES            = YES
JAVADOC_AUTOBRIEF      = YES
JAVADOC_BANNER         = YES
MULTILINE_CPP_IS_BRIEF = YES
EXTENSION_MAPPING      = h=C++
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_METHODS  = YES
EXTRACT_ANON_NSPACES   = YES
SHOW_NAMESPACES        = NO
INPUT                  = fileA.h \
                         fileA.cpp
RECURSIVE              = YES
SOURCE_BROWSER         = YES
DIR_GRAPH_MAX_DEPTH    = 10

doxygen warning with nested function

0 Answers