[PATCH] D88446: docs: add documentation describing API Notes

This revision was landed with ongoing or failed builds. This revision was automatically updated to reflect the committed changes. Closed by commit rG85d506400081: docs: add documentation describing API Notes (authored by compnerd). Changed prior to commit:

[PATCH] D88446: docs: add documentation describing API Notes

rsmith accepted this revision. rsmith added a comment. Thanks, looks good to me. Comment at: clang/docs/APINotes.rst:250-252 + Note that the type is *not* parsed in the context where it will be used, + which means that macros are not available and nullability must be applied

[PATCH] D88446: docs: add documentation describing API Notes

compnerd updated this revision to Diff 295924. compnerd marked an inline comment as done. compnerd added a comment. Address feedback from @rsmith Repository: rG LLVM Github Monorepo CHANGES SINCE LAST ACTION https://reviews.llvm.org/D88446/new/ https://reviews.llvm.org/D88446 Files:

[PATCH] D88446: docs: add documentation describing API Notes

compnerd marked 2 inline comments as done. compnerd added inline comments. Comment at: clang/docs/APINotes.rst:233-235 + Note that the type is *not* parsed in the context where it will be used, + which means that macros are not available and nullability must be applied +

[PATCH] D88446: docs: add documentation describing API Notes

rsmith added inline comments. Comment at: clang/docs/APINotes.rst:233-235 + Note that the type is *not* parsed in the context where it will be used, + which means that macros are not available and nullability must be applied + explicitly (even in an

[PATCH] D88446: docs: add documentation describing API Notes

compnerd updated this revision to Diff 295835. compnerd added a comment. Update text based on feedback. Repository: rG LLVM Github Monorepo CHANGES SINCE LAST ACTION https://reviews.llvm.org/D88446/new/ https://reviews.llvm.org/D88446 Files: clang/docs/APINotes.rst

[PATCH] D88446: docs: add documentation describing API Notes

compnerd marked an inline comment as done. compnerd added inline comments. Comment at: clang/docs/APINotes.rst:216 +Due to a compiler bug, 'NullabilityOfRet' may change nullability of the +parameters as well (rdar://30544062). Avoid using it and instead use +

[PATCH] D88446: docs: add documentation describing API Notes

hlopko accepted this revision. hlopko added a comment. This revision is now accepted and ready to land. Thanks for pushing this forward! Current proposal seems to be only dealing with annotating ObjC for Swift, but API notes seem like a feature that would be useful for other languages as well.

[PATCH] D88446: docs: add documentation describing API Notes

compnerd marked 3 inline comments as done. compnerd added inline comments. Comment at: clang/docs/APINotes.rst:45 +Clang will search for API notes files next to module maps only when passed the +``-fapinotes-modules`` option. + rsmith wrote: > Can we add a

[PATCH] D88446: docs: add documentation describing API Notes

rsmith added a comment. Broadly, it seems reasonable to me for Clang to support this. I have no major concerns with the overall approach here, and it seems like you already have sufficient implementation experience with this approach to know that it's going to work out well in practice. I'm

[PATCH] D88446: docs: add documentation describing API Notes

compnerd created this revision. compnerd added reviewers: MForster, gribozavr2, rsmith. Herald added a subscriber: jfb. Herald added a project: clang. compnerd requested review of this revision. API Notes are a feature which allows annotation of headers by an auxiliary file that contains metadata