eclipse-score / eclipse-score/lifecycle
Cleanup code documentation
- Dominant language
- C++
- Stars
- 6
- Forks
- 34
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 80
Description
### What
All documentation of the code shall use the same format
```cpp
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
```cpp
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_
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.