spadgos / sublime-jsdocs

Simplifies writing DocBlock comments in Javascript, PHP, CoffeeScript, Actionscript, C & C++

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

missing @brief section

Asalle opened this issue · comments

commented

When I got a member-function, like

int func(int a, int b);

I get the following doxygen snippet:

   /**
    * [func description]
    * @param  a [description]
    * @param  b [description]
    * @return      [description]
    */
    int func(int a, int b);

and no @brief section, just the [func description]. Is it a bug or a feature?

@brief is a Doxygen only keywork (and it's not an issue to remove it). So can be considered as a feature

If it's a need, some others packages support it:

  • DoxyDoc that force @brief. This package only support C and as a lot of issues
  • DoxyDoxygen even more flexible than DocBlockr (support some C++17 in the last version) but license required (evaluation is unlimited)