Skip to content

Feature request - Doxygen stub generation #5683

@michelleangela

Description

@michelleangela

Summary:
Be able to generate Doxygen stub comments above a function.

Example:
For the function int addition(int a, int b, int c), the following stub comment will be generated above the function

/// @brief
/// @param a
/// @param b
/// @param c
/// @return
int addition(int a, int b, int c)

Generated documentation comments styles:

  • Doxygen ///
  • Doxygen /**
  • Doxygen /*!
  • Doxygen //!

This specification is in progress and may change. More details to follow on:

  • Settings
  • Generate stub for class or struct or other symbols?

Note: the issue tracking to display Doxygen comments on tooltips (such as from hover over a symbol) is at #658.

Metadata

Metadata

Assignees

Labels

Feature RequestFeature: Doc commentsAn issue related to code comments shown in hover, completion, and signature help.Language ServicefixedCheck the Milestone for the release in which the fix is or will be available.

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions