eclipse-iceoryx / eclipse-iceoryx/iceoryx

Refactor `iox_LogLevel` to be consistent with c binding enum names

Open
#1,650 1 comment 1 reaction 0 assignees View on GitHub
refactoring
Dominant language
C++
Stars
2.2k
Forks
492
Avg merge
18h 57m
Merged PRs (30d)
1

Description

## Brief feature description

Refactor the `iox_LogLevel` in `iceoryx_binding_c/include/iceoryx_binding_c/log.h` so that it follows the unwritten but consistent naming conventions of enums inside the c binding.
1. enum name is identical to the c++ enum class name with an `iox_` prefix
2. enum values have the c++ enum class name as a prefix.

This would lead to:
```cxx
enum iox_LogLevel {
LogLevel_Off,
LogLevel_Trace,
//....
}
```

without the `iceoryx_` prefix

Contributor guide

Open the contributing guide

Research direction

Start with iceoryx_binding_c/include/iceoryx_binding_c/log.h and compare its iox_LogLevel declaration with the corresponding C++ enum class. Update the enum and value names to follow the stated binding convention, then verify references to the old names across the C binding. Done means the declaration and its uses consistently use the new names.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, cpp
Domain
api
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.