Skip to content

Doxygen alias support #12752

@alexandruavadanii

Description

@alexandruavadanii

Type: Feature Request

This is similar (if not identical) to #5700 - adding support for Doxygen aliases like @par instead of @param, @input instead of @param[in] etc.

My use-case is probably unique, working on a large codebase documented with SourceDoc [2], an older source documenting tool that uses a syntax which overlaps a lot with Doxygen and can be parsed by Doxygen specific tools (including cpptools) with the appropiate aliases.
However, generic Doxygen alias support is probably not that rare and might help others too.

Ideally, aliases would allow setting the display name in the hover, but for the regular Doxygen parsing those seem to be localized, so that part might be tricky.

If aliases are hard to implement, maybe we could at least define our custom tags and their hover diplay name.

Disabling Simplify Structured Comments is not a viable alternative, the result is too much of paragraph soup to be intelligible, we cannot customize the sections to be filtered in the hover etc.

Code example:

/**
 * @function cpptools_test1
 * @brief desc for this void func.
 *
 * @input   p1    Input arg.
 * @output  p2    Output args.
 */
static void
cpptools_test1(void *p1, void *p2)
{
   (void)p1;
   (void)p2;
}

[1] https://www.doxygen.nl/manual/config.html#cfg_aliases
[2] https://sourceforge.net/projects/scdoc/

Extension version: 1.22.3
VS Code version: Code - Insiders 1.94.0-insider (4f485cf59847506bc1ba2aaab127d31dcbe2c9dc, 2024-09-18T09:24:10.356Z)
OS version: Windows_NT x64 10.0.22631
Modes:
Remote OS version: Linux x64 4.18.0-513.11.1.el8_9.0.1.x86_64

Metadata

Metadata

Assignees

No one assigned

    Labels

    Feature RequestFeature: Doc commentsAn issue related to code comments shown in hover, completion, and signature help.Language Servicemore votes neededIssues that have been postponed until more community members upvote it

    Type

    No type

    Projects

    Status

    Done

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions