Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Brief description not generated for methods defined outside class #337

Open
slim71 opened this issue Nov 12, 2024 · 0 comments
Open

Brief description not generated for methods defined outside class #337

slim71 opened this issue Nov 12, 2024 · 0 comments
Labels

Comments

@slim71
Copy link

slim71 commented Nov 12, 2024

Describe the bug
I think the generation based on the smart snippet is not working when trying to add docstrings to class setters/getters defined outside of the class itself.
Or at least, I seem not to be able to make it work. If I delete the class specifier, it does use the smart text snippet.

Code example

void Cargo::setRunning() {
    std::lock_guard lock(this->running_mutex_);
    this->running_ = true;
}

Expected result

/**
 * @brief Set the Running object
 * 
 */
void Cargo::setRunning() {
    std::lock_guard lock(this->running_mutex_);
    this->running_ = true;
}

Actual result

/**
 * @brief 
 * 
 */
void Cargo::setRunning() {
    std::lock_guard lock(this->running_mutex_);
    this->running_ = true;
}

Screencaps
Screencast from 12-11-2024 23_18_31

Your System:

  • OS: Ubuntu 22.04
  • VS Code Version: 1.95.2
  • Doxdocgen Code Version: v1.4.0

Additional context
I haven't changed anything of the default configuration, apart from author info.

@slim71 slim71 added the bug label Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant