Skip to content

Compodoc (Frontend)

Frontend Coverage

Disponible en GitHub Pages: https://fjbatresv.github.io/sdg19-final/compodoc/

Terminal window
npx nx run web:docs

Salida: dist/compodoc/web.

Terminal window
npx nx run web:docs:coverage
  • Umbral global: >= 80%.
  • Minimo por archivo: >= 25%.
  • Compodoc falla el comando si no se alcanza el umbral.
  • Para reducir ruido, sólo se listan los elementos con documentación faltante.
Terminal window
npx nx run web:docs:check

El sitio se publica en GitHub Pages bajo la ruta del repositorio:

https://<org>.github.io/<repo>/

Para asegurar que el sitio funcione bajo subpath, el workflow aplica un patch del <base href> usando tools/compodoc/patch-base.js.

  • El workflow docs-pages.yml genera Compodoc y lo publica en GitHub Pages.
  • En CI se valida la cobertura con nx run web:docs:coverage.
  • Añade JSDoc (/** ... */) a componentes, servicios y otros artefactos públicos de Angular.
  • Documenta métodos públicos y propiedades expuestas relevantes.