Skip to content

Cleanup code documentation #578

Description

@MaciejKaszynski

What

All documentation of the code shall use the same format

struct ProcessInfoData
{
    int32_t status_ = -1;              ///< Exit status for process
    IComponent* component_ = nullptr;  ///< Pointer to the termination callback associated with this item.
};

shall be changed to

struct ProcessInfoData
{
    /// @brief Exit status for process.
    int32_t status_ = -1;

    /// @brief Pointer to the termination callback associated with this item.
    IComponent* component_ = nullptr;
};

Acceptance Criteria (DoD)

  • All docstrings changed

How

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions