DynamoRIO / DynamoRIO/dynamorio

Add lint rule to catch use of #else/#elif in _api.h headers which blocks content from doxygen output

Open
#5,496 0 comments 0 reactions 1 assignee Claimed by @bete0 View on GitHub
Component-Docs Type-Feature
Dominant language
C
Stars
3.2k
Forks
629
Avg merge
2d 15h
Merged PRs (30d)
31

Description

We have API.doxy defining all of our OS and arch defines in its `PREDEFINED` and are supposed to avoid `#else` or `#elif` in _api.h headers we get all content for all platforms in our docs.

I see at least one comment about this:
```
core/ir/instr_api.h:/* We resist using #elif here because otherwise doxygen will be unable to
```

But it looks like there are a bunch of instances of elses in other headers.
We should add some kind of lint rule to help us here.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.