cschlosser / doxdocgen

Generate doxygen documentation from source code in VS Code
https://marketplace.visualstudio.com/items?itemName=cschlosser.doxdocgen
MIT License
264 stars 55 forks source link

Feature suggest: multiline template #127

Closed eternalphane closed 4 years ago

eternalphane commented 5 years ago

Description

Currently \n in template result in a naked new line. It would be better to have continuous indent and comment prefix before each line.

Code example

{
    "doxdocgen.c.commentPrefix": "/// ",
    "doxdocgen.c.firstLine": "",
    "doxdocgen.c.lastLine": "",
    "doxdocgen.generic.briefTemplate": "<summary>\n{text}\n</summary>",
    "doxdocgen.generic.paramTemplate": "<param name=\"{param}\">\n</param>",
}
class response : public impl::with_body
{
public:
    response(QNetworkReply* data=nullptr);
...

Expected result

class response : public impl::with_body
{
public:
    /// <summary>
    /// Construct a new response object
    /// </summary>
    /// <param name="data">
    /// </param>
    response(QNetworkReply* data=nullptr);
...

Actual result

class response : public impl::with_body
{
public:
    /// <summary>
Construct a new response object
</summary>
    /// <param name="data">
</param>
    response(QNetworkReply* data=nullptr);
...
cschlosser commented 5 years ago

The comment prefix is up to you to do. Indenting may be possible some time in the future.