Предупреждения о кислороде - PullRequest
Новая
       10

Предупреждения о кислороде

0 голосов
/ 06 февраля 2019

Мой компилятор выдавал предупреждения, когда я пытаюсь использовать doxygen с моим файлом cpp.Увидеть ниже.Что я должен изменить в соответствии с doxygen?Ваша помощь очень ценится.

/ home / user / cpplab4 / list.cpp: 33: предупреждение: задокументированный символ `CS150 :: list :: list 'не был объявлен или определен.

/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;
}

1 Ответ

0 голосов
/ 06 февраля 2019

Ваши комментарии говорят следующее:

\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, чтобы найти идеи о том, как ее лучше всего использовать..

...