microsoft / microsoft/vscode-cpptools

Doxygen comment generates "@param" for function with "void" parameter

Open
#11,287 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug Feature: Doc comments Language Service Visual Studio
Dominant language
TypeScript
Stars
6.2k
Forks
1.7k
Avg merge
14h 46m
Merged PRs (30d)
61

Description

Environment
  • C/C++ Extension Version: 1.16.3
Bug Summary and Steps to Reproduce

Reported in issue https://github.com/microsoft/vscode-cpptools/issues/11282.

Bug Summary:
Dogyxen generation comment creates @param for a function with void in parameter list.

Sample code:

int my_function(void)
{
return 0;
}

Steps to reproduce:

  1. Use sample code.
  2. Right-click on my_function
  3. Select "Generate Doxygen Comment"

Actual result:

/// @brief 
/// @param  
/// @return 
int my_function(void)
{
return 0;
}

Expected behavior:

/// @brief 
/// @return 
int my_function(void)
{
return 0;
}
Configuration and Logs
n/a
Other Extensions

No response

Additional context

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue with the provided C++ sample and the "Generate Doxygen Comment" command. Trace the comment-generation entry point, then verify that a function declared with void produces no @param line while retaining @brief and @return output.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, typescript
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.