Azure / Azure/azure-sdk-tools

C99 named enum values don't show the integer but rather how it is generated

Open
#953 1 comment 0 reactions 0 assignees View on GitHub
APIView C99 feature-request
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
144

Description

This is a lower priority, however, the enum values in Apiview that are generated using macros, show too much implementation detail rather than just the integer values themselves.

Is there something we can do about this?

https://apiview.dev/Assemblies/Review/2339253c7f1343dabf7d78ee5b4496aa#az_result.h

https://github.com/Azure/azure-sdk-for-c/blob/c12a0107925b004be6f130f986999b33acd1c9fa/sdk/inc/azure/core/az_result.h#L49-L132

![image](https://user-images.githubusercontent.com/6527137/92155752-ba281b00-eddc-11ea-9849-06cea6a007ef.png)

Ideally, they would look more like:
https://apiview.dev/Assemblies/Review/2339253c7f1343dabf7d78ee5b4496aa#az_http.h

```C
typedef enum
{
AZ_OK = 65536,
AZ_ERROR_CANCELED = -2147418112,
// and so on...
```
cc @pakrym, @RickWinter

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the ApiView rendering for the linked az_result.h enum and compare it with az_http.h, focusing on values generated through macros. Trace the ApiView code that parses or displays C99 enum values; done means macro-generated values are shown as their resolved integers without the implementation detail.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.