mono/SkiaSharp

Migrate to inline code docs

Opened this issue · 1 comments

Description

Can you help migrate my docs from the docs folder into the c# source.

  • There is a guide here: ~/API.Docs.Migration.Guide.md
  • This is the checklist of APIs to migrate: ~/API.Docs.Migration.Checklist.md

Please go through each item on the checklist and migrate.

Setup

Make sure that BEFORE you start, checkout all submodules. Don't try build anything or run any tests. The agents are not set up to do this.

Migration

Just go through the checklist and migrate each type.

There is one important thing. Each type should be migrated and commited separately. We have a team that looks at things by commit and they do not want to have multiple types being done in a single commit.

Migrate all the members in the types.

Rules

  • Migrate one type at a time
  • Migrate all the mebers on the type, even if there are many
  • Commit the changes for each type
  • Do not skip a type or member

Triage Summary

The label for area/Docs will be applied indicating that the issue pertains to documentation management specifically related to migrating documentation.

This issue is not a regression as it is focused on documentation migration and does not involve any previously functional features.

Additional remarks:

  • The issue is primarily about migrating documentation and does not relate to any specific backend technology, compatibility, performance, or reliability issues.
  • There are no references to operating system-related problems or relevant labels that would apply.
Detailed Summary and Actions

Summary of the triage:

  • The issue is focused on migrating documentation from a folder to inline code docs.
  • The applicable label is area/Docs, indicating that it relates strictly to documentation management.
  • There are no underlying issues related to technology compatibility, performance, or reliability, nor any regression to be noted.

Summary of the actions that will be performed:

Action Item Description
Apply Label area/Docs The issue concerns migrating documentation from a folder to inline code docs.

This entire triage process was automated by AI and mistakes may have been made. Please let us know so we can continue to improve.