Doxygen的警告

问题描述 投票:0回答:1

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

/home/user/cpplab4/list.cpp:33:警告:记录符号`CS150 ::目录::清单”未声明或定义。

/home/user/cpplab4/list.cpp:46:警告:记录符号`节点* CS150 ::目录:: 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;
}
c++ doxygen
1个回答
2
投票

您的意见说以下内容:

\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文档再次就如何最好地使用它的想法。

© www.soinside.com 2019 - 2024. All rights reserved.