Skip to content

Brief description not generated for methods defined outside class #337

@slim71

Description

@slim71

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions