переменные класса и функции doxygen не документированы должным образом - PullRequest
Новая
       24

переменные класса и функции doxygen не документированы должным образом

0 голосов
/ 24 октября 2018

Я впервые использую Doxygen. Я пытаюсь документировать свой проект на c ++, используя Doxygen.
Я не получаю надлежащую документацию для моего класса / переменных.
Вот код:

/**
 * Parse tree node for each symbol
 */
class node
{
    public:

node* left;/**left-address of left child*/
node* right;/**right-address of right child*/   
char ch;/**ch-character in the node*/


/**
 *constructor for node
 *
 *@param le left child address
 *@param ri right child address
 *@param c character to be put in the node
 */
node(node* le,node* ri,char c)
{
    left=le;
    right=ri;
    ch=c;
}

};

, а также здесь: 

/**
 *@brief returns priority
 *
 *Takes an operand and returns its priotity based on precedence.
 *Return -1 for '(' so that it always remains on the stack until ')' is encountered in infix.
 *
 *@param c operand or '('
 *
 *@return priority value
 */ 

int priority(char c)          
{ 
     switch(c)
    { 
        case '>': return  0 ; 
        case 'V': return  1 ; 
        case '^': return  1 ; 
        case '~': return  2 ; 
        case '(': return -1 ;           
        } 
    }

    stack <char> op ;//*<stack of operaators*/

Также я не получаю никакой документации в snippet1 для моих переменных-членов и class.Same для priority функции и op глобальной переменной.
Я испробовал обе записи для моих переменных:
stack <char> op ;//*<stack of operaators*/
и
node* left;/**left-address of left child*/

Все, что было показано, это то, что переменная op существовала и существовала функция приоритетапод документацией без какого-либо описания, приведенного в комментариях. То же самое относится к классу node. Может кто-нибудь помочь мне понять, что с этим не так?

...