Change cpp doxygen style

[Perry3D]

Hi,

is there a way to configure Neogen to use the triple dash style instead of c-style comments?
Currently the doxygen looks like this:

/**
 * @brief 
 *
 * @param a 
 * @param b 
 * @return 
 */
int add(int a, int b);

My company code style is like this:

/// @brief 
/// @param a 
/// @param b 
/// @return 
int add(int a, int b);

Thank you for this great plugin!

[danymat]

Hello ! I'm currently in the process of refactoring the codebase to expose more easily the annotation standards, and providing better docs for it !
But now, you can take a look Neogen works in c:

neogen/lua/neogen/configurations/c.lua

Lines 175 to 189 in 7b9157d

	doxygen = {
	{ nil, "/**", { no_results = true, type = { "func", "file" } } },
	{ nil, " * @file", { no_results = true, type = { "file" } } },
	{ nil, " * @brief $1", { no_results = true, type = { "func", "file" } } },
	{ nil, " */", { no_results = true, type = { "func", "file" } } },
	{ nil, "", { no_results = true, type = { "file" } } },
	{ nil, "/**", { type = { "func" } } },
	{ nil, " * @brief $1", { type = { "func" } } },
	{ nil, " *", { type = { "func" } } },
	{ "tparam", " * @tparam %s $1" },
	{ "parameters", " * @param %s $1" },
	{ "return_statement", " * @return $1" },
	{ nil, " */" },
	},

This is the template responsible for generating Doxygen in C. You can see that every second parameter of each table is a string, and note that:

• $1 is the cursor placement
• %s will be replaced by the value

So for you, the Doxygen table could be something like:

        custom = {
            { nil, "/// @file", { no_results = true, type = { "file" } } },
            { nil, "/// @brief $1", { no_results = true, type = { "func", "file" } } },
            { nil, "", { no_results = true, type = { "file" } } },

            { nil, "/// @brief $1", { type = { "func" } } },
            { "tparam", "/// @tparam %s $1" },
            { "parameters", "/// @param %s $1" },
            { "return_statement", "/// @return $1" },
        },

And to use in your Neogen setup:

require('neogen').setup {
    enabled = true,
	languages = {
	    c = {
	        template = {
                    annotation_convention = "custom",
                    custom =  {
                      { nil, "/// @file", { no_results = true, type = { "file" } } },
                      { nil, "/// @brief $1", { no_results = true, type = { "func", "file" } } },
                      { nil, "", { no_results = true, type = { "file" } } },

                       { nil, "/// @brief $1", { type = { "func" } } },
                       { "tparam", "/// @tparam %s $1" },
                        { "parameters", "/// @param %s $1" },
                        { "return_statement", "/// @return $1" },
                    },
		}
	    },
	    ...
    }
}

Tell me if it works !

[Perry3D]

Thank you very much for the detailed answer. Works fine for me.
Except one copy paste thing: you set the template for lua instead of c or cpp.

require('neogen').setup {
  enabled = true,
  languages = {
    cpp = {
      template = {
        annotation_convention = "custom",
        custom =  {
          { nil, "/// @file", { no_results = true, type = { "file" } } },
          { nil, "/// @brief $1", { no_results = true, type = { "func", "file" } } },
          { nil, "", { no_results = true, type = { "file" } } },

          { nil, "/// @brief $1", { type = { "func" } } },
          { "tparam", "/// @tparam %s $1" },
          { "parameters", "/// @param %s $1" },
          { "return_statement", "/// @return $1" },
        },
      }
    },
  }
}

[danymat]

Oh yeah right, fixed