doxdocgen icon indicating copy to clipboard operation
doxdocgen copied to clipboard

Improve display of empty lines in doxdocgen.generic.order

Open cschlosser opened this issue 2 years ago • 0 comments

I actually like the c/dtor texts. But they should overwrite the brief template.

On the empty lines: This is my config now. It works great for functions and methods (as discussed above):

"doxdocgen.generic.briefTemplate": "<brief description>{text}",
"doxdocgen.generic.customTags": ["<detailed description>"],
"doxdocgen.generic.paramTemplate": "\\param[<in/out>] {param}{indent:32}<parameter description>",
"doxdocgen.generic.returnTemplate": "\\retval <value>{indent:32}<value description. Use \\return <descripton> when there are no specific values>",
"doxdocgen.c.commentPrefix": "//! ",
"doxdocgen.c.lastLine": "//!",
"doxdocgen.c.firstLine": "",
"doxdocgen.c.triggerSequence": "//!",
"doxdocgen.generic.order": [
    "brief",
    "empty",
    "custom",
    "empty",
    "tparam",
    "param",
    "empty",
    "return"
  ],

On all other elements, it does not work great: grafik

I guess, this is from the "empty" lines in doxdocgen.generic.order. Removing doxdocgen.generic.order (or the empty lines) make it look ok: grafik

They should only be there, when there is the following chapter. I propose the following setting:

"doxdocgen.generic.emptyLineBeforeChapter" = ["details", "custom", "tparam", "param", "return"] // or "none" / "all"
 "doxdocgen.generic.emptyLineAfterChapter" = ["return"] // or "none" / "all"

Originally posted by @KUGA2 in https://github.com/cschlosser/doxdocgen/issues/259#issuecomment-981415621

cschlosser avatar Feb 24 '22 18:02 cschlosser