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.

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

[Epic] Mejorar los WollokDoc #169

Open
9 tasks
PalumboN opened this issue Jan 7, 2024 · 0 comments
Open
9 tasks

[Epic] Mejorar los WollokDoc #169

PalumboN opened this issue Jan 7, 2024 · 0 comments

Comments

@PalumboN
Copy link
Contributor

PalumboN commented Jan 7, 2024

Armando el nuevo sitio y generando la WollokDoc, me di cuenta de algunas cosas que estaría bueno mejorar:

  • Ordenar las clases en los archivos (por ejemplo, que Object esté al inicio de lang.wlk y no las excepciones (? )
  • Documentar las clases que faltan (varias de Game por ejemplo)
  • Mejorar las anotaciones (ahora hay cosas como @private en los comentarios)
    • Sacar el @author
    • Normalizar los @returns y @throws (algunos métodos los tienen, otros no)
    • Normalizar los @see para que permitan navegar
    • Cambiar los @private por annotations de verdad -> renombrar a @hidden? para que no se sugieran en el autocomplete (ni en la doc del sitio?)
    • Ver si no es mejor mover todos como annotations de verdad
  • Retomar el laburo de Juan de tener la doc internacionalizada: Agregar "Guía completa del lenguaje" en español wollok#1988
@PalumboN PalumboN changed the title Mejorar los WollokDoc [Epic] Mejorar los WollokDoc Nov 11, 2024
@PalumboN PalumboN added the epic label Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant