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.

Sign up for GitHub

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

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

Open
4 tasks
rolfbjarne opened this issue Jan 30, 2023 · 0 comments
Open
4 tasks

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

rolfbjarne opened this issue Jan 30, 2023 · 0 comments
Assignees
@rolfbjarne
Labels
documentation The issue or pull request is about documentation dotnet An issue or pull request related to .NET (6)
Milestone
.NET 10

Comments

@rolfbjarne
Copy link
Member

rolfbjarne commented Jan 30, 2023 •
edited
Loading

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:
@rolfbjarne rolfbjarne added documentation The issue or pull request is about documentation dotnet An issue or pull request related to .NET (6) labels Jan 30, 2023
@rolfbjarne rolfbjarne added this to the .NET 8 milestone Jan 30, 2023
@rolfbjarne rolfbjarne mentioned this issue Jan 30, 2023
Open
6 tasks
@rolfbjarne rolfbjarne modified the milestones: .NET 8, .NET 9 Sep 8, 2023
@rolfbjarne rolfbjarne self-assigned this Mar 8, 2024
rolfbjarne added a commit to rolfbjarne/xamarin-macios that referenced this issue May 31, 2024
@rolfbjarne
[src/docs] Add xml documentation for types.
cb24edf 
Import all the xml documentation for types from https://github.com/xamarin/apple-api-docs.

Some of this documentation should probably be rewritten, and potentially moved
to conceptual documentation, in particular those that contain images (because
images can't be imported into xml documentation).

The xml documentation for members will come in a later PR.

Partial fix for dotnet#17399.
@rolfbjarne rolfbjarne mentioned this issue May 31, 2024
Merged
rolfbjarne added a commit that referenced this issue Jun 6, 2024
@rolfbjarne
[src/docs] Add xml documentation for types. (#20672)
7670afb 
Import all the xml documentation for types from https://github.com/xamarin/apple-api-docs.

Some of this documentation should probably be rewritten, and potentially moved
to conceptual documentation, in particular those that contain images (because
images can't be imported into xml documentation).

Note that the documentation hasn't been modified in any way; that's not the purpose of this PR. If documentation should be modified for whatever reason, it can be done in a later PR.

The xml documentation for members will come in a later PR.

Partial fix for #17399.
@github-project-automation github-project-automation bot moved this to Documentation in .NET 9 Aug 27, 2024
@rolfbjarne rolfbjarne modified the milestones: .NET 9, .NET 10 Sep 27, 2024
@rolfbjarne rolfbjarne removed this from .NET 9 Sep 27, 2024
@rolfbjarne rolfbjarne mentioned this issue Feb 19, 2025
Merged
rolfbjarne added a commit that referenced this issue Feb 24, 2025
@rolfbjarne
[src] Import xml docs for members, part 1. (#22210)
4f13e06 
This has to be done in parts, because the Roslyn importer runs out of
memory otherwise.

Which also means I have no idea how many parts there will end up being.

Partial fix for #17399.
rolfbjarne added a commit that referenced this issue Feb 24, 2025
@rolfbjarne
[src] Import xml docs for members, part 2.
a6b5f13 
This has to be done in parts, because the Roslyn importer runs out of memory otherwise.

Which also means I have no idea how many parts there will end up being.

Partial fix for #17399.
@rolfbjarne rolfbjarne mentioned this issue Feb 24, 2025
Merged
rolfbjarne added a commit that referenced this issue Feb 26, 2025
@rolfbjarne
[src] Import xml docs for members, part 2.
1ac9ac0 
This has to be done in parts, because the Roslyn importer runs out of memory otherwise.

Which also means I have no idea how many parts there will end up being.

Partial fix for #17399.
rolfbjarne added a commit that referenced this issue Feb 28, 2025
@rolfbjarne
[src] Import xml docs for members, part 2. (#22239)
1370c80 
This has to be done in parts, because the Roslyn importer runs out of
memory otherwise.

Which also means I have no idea how many parts there will end up being.

Partial fix for #17399.
rolfbjarne added a commit that referenced this issue Mar 5, 2025
@rolfbjarne
[src] Import xml docs for members, part 3.
29cde78 
This has to be done in parts, because the Roslyn importer runs out of memory otherwise.

Which also means I have no idea how many parts there will end up being.

Partial fix for #17399.
@rolfbjarne rolfbjarne mentioned this issue Mar 5, 2025
Merged
rolfbjarne added a commit that referenced this issue Mar 6, 2025
@rolfbjarne
[src] Import xml docs for members, part 3. (#22307)
9368b95 
This has to be done in parts, because the Roslyn importer runs out of memory otherwise.

Which also means I have no idea how many parts there will end up being.

Partial fix for #17399.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rolfbjarne rolfbjarne

Labels
documentation The issue or pull request is about documentation dotnet An issue or pull request related to .NET (6)
Projects
None yet
Milestone
.NET 10
Development

No branches or pull requests
1 participant
@rolfbjarne