sublime-jsdocs icon indicating copy to clipboard operation
sublime-jsdocs copied to clipboard

C/C++ function args not interpreted

Open ioncube opened this issue 9 years ago • 2 comments

Adding a doc comment for a signature such as static void bar(int a, float b) produces just:

/**
 * @param
 * @param
 */

Is C/C++ syntax not more fully recognised at this point?

ioncube avatar Sep 08 '15 11:09 ioncube

Two month ago, I was in the same case then you... I have look for alternative. I have considered DoxyDoc, but this C++ dedicated plugin provide poor result in my case... Then, I decided to write my own, based another approach: DoxyDoxygen. Have you already test it ?

Here, the result of your test case (may also help DocBlockr maintainer):

/**
 * @brief      { function_description }
 *
 * @param[in]  a     { parameter_description }
 * @param[in]  b     { parameter_description }
 */
static void bar(int a, float b);

/**
 * @brief      { function_description }
 *
 * @param[in]  someVar  { parameter_description }
 */
SomeClass::SomeClass(SomeType someVar);

/**
 * @brief      { function_description }
 */
SomeClass::~SomeClass();

/**
 * @brief      { function_description }
 *
 * @param[in]  someVar  { parameter_description }
 *
 * @return     { description_of_the_return_value }
 */
someType SomeClass::SomeInnerClass::someMethod(SomeType someVar);

Regards,

20Tauri avatar Sep 10 '15 23:09 20Tauri

@20Tauri Very useful. Thanks.

mustekito avatar Feb 09 '16 12:02 mustekito