氧气警告

Doxygen warnings

本文关键字:警告 氧气      更新时间:2023-10-16

当我尝试在 cpp 文件中使用 doxygen 时,我的编译器发出了警告。见下文。我必须改变什么以适应氧气?非常感谢您的帮助。

/

home/user/cpplab4/list.cpp:33:警告:未声明或定义记录的符号"CS150::list::list"。

/

home/user/cpplab4/list.cpp:46:警告:未声明或定义记录的符号"节点 * CS150::list::make_node"。

  /****************************************************************/ 
  /*!
  * class CS150
  * brief namespace
  * 
  */
  /****************************************************************/ 
   /**********************************************************************/
   /*!
   * class CS150::list() 
   * brief initialise the_list, constructor 
   */
   /**********************************************************************/ 
list::list() 
{  
    the_list = nullptr;
    list_size =0;
}
   /**********************************************************************/
   /*!
   * class CS150::node *list::make_node(int val)
   * brief Allocate memory and set members.
   * param val to be placed in new node    
   * return return node  
   */
    /*********************************************************************/
node *list::make_node(int val)
{
    node *pnode = new node;
    pnode->value = val;
    pnode->next = nullptr;  
    return pnode;
}

您的评论如下:

class CS150

"有个班叫CS150。">

class CS150::list()

"有一个类叫CS150::list()"。

class CS150::node *list::make_node(int val)

"有一个类叫CS150::node *list::make_node(int val)"。

这些说法都不是真的,这真的让Doxygen感到困惑。看起来您正在尝试使用命令 class 记录所有内容(包括命名空间?但是这个命令是针对类的。

我想你可能的意思是第一个块中的class list(尽管这似乎没有任何用处(,所有其他的都应该被删除:Doxygen知道你正在记录哪个函数以及它叫什么。没有必要也没有办法告诉它。

因此,例如,只需:

/*!
 * brief Allocate memory and set members.
 * param val to be placed in new node    
 * return return node  
 */
node *list::make_node(int val)
{
    node *pnode = new node;
    pnode->value = val;
    pnode->next = nullptr;  
    return pnode;
}

我建议您再次浏览 Doxygen 文档,了解如何最好地使用它。