Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[SR-13146] [docs] Document ClangImporter pieces - BuiltinMappedTypes.def and MappedTypes.def #55593

Open
typesanitizer opened this issue Jul 5, 2020 · 3 comments
Open

[SR-13146] [docs] Document ClangImporter pieces - BuiltinMappedTypes.def and MappedTypes.def #55593

typesanitizer opened this issue Jul 5, 2020 · 3 comments
Labels
compiler The Swift compiler in itself documentation task

Comments

@typesanitizer
Copy link

Previous ID SR-13146
Radar rdar://problem/65111082
Original Reporter @typesanitizer
Type Task
Additional Detail from JIRA
Votes 0
Component/s Compiler
Labels Task, Documentation
Assignee None
Priority Medium

md5: b06241749803316da8fd5f34e4e61b75

Issue Description:

This forum post points out that it is not super clear why there are two of these, and what they do.

https://forums.swift.org/t/clangimporter-what-compiler-code-effects-the-mapping-of-c-types-to-stdlib-types/38186

We could a better job at documenting the purpose of each file and how they fit into the overall process of importing types.
@typesanitizer
Copy link
Author

So looks like my comment in the forum post is mostly correct, we could probably adapt it and put in the docs. https://forums.swift.org/t/clangimporter-what-compiler-code-effects-the-mapping-of-c-types-to-stdlib-types/38186/2

@typesanitizer
Copy link
Author

@swift-ci create

@typesanitizer
Copy link
Author

To clarify, the idea here would be to expand the doc comments in the individual .def files. Perhaps we also want to mention their names from one another so someone can compare and contrast.

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
compiler The Swift compiler in itself documentation task
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@typesanitizer