Skip to content

Import our existing documentation from xamarin/apple-api-docs as triple-slash documentation. #17399

@rolfbjarne

Description

@rolfbjarne

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:

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:

Metadata

Metadata

Assignees

Labels

documentationThe issue or pull request is about documentationdotnetAn issue or pull request related to .NET (6)

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions