llvm/llvm-project

[clang][ExtractAPI] Declaration fragments should show types as shown in the source code.

Open

#61,157 opened on Mar 3, 2023

View on GitHub
 (15 comments) (0 reactions) (0 assignees)C++ (10,782 forks)batch import
clang:toolinggood first issue

Repository metrics

Stars
 (26,378 stars)
PR merge metrics
 (Avg merge 1d 2h) (1,000 merged PRs in 30d)

Description

For Objective-C APIs that use typedefs, ExtractAPI emits declarations with the original’s type’s name rather than its typedef name.

For example, in:

typedef struct MyStruct * MyTypeDef;

void foo(MyTypeDef x) {}

The declaration for foo is the following:

void foo(struct MyStruct * x)

Rather than:

void foo(MyTypeDef x)

Resolving this issue will align the declaration we generate to the one that’s in the original source code.

Contributor guide

Research direction
Investigate the ExtractAPI module in Clang, specifically the declaration fragment generation logic. Trace how type information is retrieved for function parameters and compare with the original typedef name. Modify the code to use the typedef name if available.
Tech stack
cpp
Domain
toolingdeveloper experience
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35