Toolverse
All skills

api-docs

by mono

Write and review XML API documentation for SkiaSharp following .NET guidelines.\nTriggers: \

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Author
mono
Category
Backend
Views
4

About this skill

Write and review XML API documentation for SkiaSharp following .NET guidelines.\nTriggers: \

How to use

  1. Zlokalizuj plik XML odpowiadający typowi, który chcesz dokumentować, w katalogu docs/SkiaSharpAPI/ — każdy typ ma własny plik (np. SKCanvas.xml, SKPaint.xml).

  2. Otwórz plik i edytuj sekcje <Docs> wewnątrz elementu typu, uzupełniając tagi <summary>, <param>, <returns> i <value> zgodnie z wytycznymi w referencjach skill'u.

  3. Sprawdź poprawność składni XML — skill zawiera narzędzia do walidacji, które wychwycą błędy przed zatwierdzeniem zmian.

  4. Uruchom polecenie dotnet cake --target=docs-format-docs, aby zwalidować i sformatować dokumentację w całym projekcie.

  5. Jeśli dodałeś nowe API do biblioteki, najpierw zregeneruj pliki XML z zestawów NuGet za pomocą narzędzia mdoc, aby upewnić się, że wszystkie nowe typy są uwzględnione.

  6. Wyślij zmiany jako pull request do repozytorium mono/SkiaSharp-API-docs — dokumentacja jest przechowywana w submodule Git i wymaga osobnego zatwierdzenia.

Related skills