-
Notifications
You must be signed in to change notification settings - Fork 559
Closed
Labels
documentationThe issue or pull request is about documentationThe issue or pull request is about documentationdotnetAn issue or pull request related to .NET (6)An issue or pull request related to .NET (6)
Milestone
Description
Ref #14372, step 5.
Write a tool (or augment an existing one) that takes the xamarin/apple-api-docs repository as input, figures out where the corresponding API is located (in our source code), and adds a triple-slash comment to the source code.
This is to be done in two steps:
- Manual binding code (the easy part)
- Api definitions (the hard part - this also depends on Add support for XML documentation in the generator #17397)
Possible starting points for the tool:
The tool would have to use Roslyn to query and edit our source code.
We might be able to add short and simple API documentation as complete triple-slash comments, but longer should use the feature to reference an external file.
Todos:
- Add tags to link samples. Existing tags: https://gist.github.com/rolfbjarne/bbcf7aaa2cadea3e923a30bb32e60327
- Images weren't imported (there's no way to add images to xml docs).
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationThe issue or pull request is about documentationThe issue or pull request is about documentationdotnetAn issue or pull request related to .NET (6)An issue or pull request related to .NET (6)