adas-core/Documentation/docs/docs/api-guide.md

Guia de API

La referencia de API se genera automaticamente desde los comentarios XML del codigo C# usando DocFX.

Navegacion

• Explora la referencia de tipos generada a partir de los proyectos de la solucion.
• Los controladores (Controllers) definen los endpoints HTTP.
• Los servicios de aplicacion (Services) contienen la logica de negocio.
• Los modelos del dominio (Domain.Models) definen las entidades y DTOs.

Convenciones de documentacion

• Cada endpoint publico debe tener un comentario XML con summary, param y returns.
• Usa see cref="..." para referenciar tipos del dominio.
• Documenta las excepciones lanzadas con exception cref="...".
• Evita cref ambiguos (como IEnumerable{T}); usa el tipo concreto o descripciones textuales.

Generacion local

Para regenerar la documentacion API:

cd Documentation/docs
dotnet docfx metadata
dotnet docfx build

El sitio se genera en _site/.