Permitir que la documentación autogenerada también se genere en español. Esta solución en particular permite escribir comentarios como el siguiente:
/**
* lang: en
* In order to maintain air-speed velocity, a Golondrina needs to beat its wings forty-three times every second
* ---
* lang: es
* Para mantener su velocidad, una Golondrina necesita batir sus alas 43 veces por segundo
*/
class Golondrina {
}
Y al correr el WollokDocParser se pasa un parámetro locale (que en este caso podría valer es o en) y según el locale pasado se va a generar documentación usando solo la parte del comentario que está en el lenguaje correspondiente.
Si el comentario no empieza con lang: se asume que no tiene localización y entonces se usa completo para generar la documentación.
Cómo
Se agregó un parámetro a WollokLauncherParameters.xtend, el locale que se pasa a el WollokDocParser.
Se modificó el script que genera la documentación para que en vez de copiar la documentación en español a inglés la genere para un lenguaje y luego para el otro.
Se extrae el timestamp que se va a poner en los archivos de documentación a una variable de instancia del WollokDocParser (antes se evaluaba dentro de un método como LocalDateTime.now), esto fue para poder testearlo más fácil.
Se agrega un paso a obtener los comentarios para generar documentación que es el localizar el comentario.
Coverage increased (+0.6%) to 84.68% when pulling ce6ef3d5ca1b89d1d2c9822628ff4f94917c5a57 on fix-1988-add-spanish-docs into 6503209b7aa1c334a799d72a3d480bcd590cb2dc on dev.
Esto es una implementación posible para resolver https://github.com/uqbar-project/wollok/issues/1988
Que
Permitir que la documentación autogenerada también se genere en español. Esta solución en particular permite escribir comentarios como el siguiente:
Y al correr el
WollokDocParser
se pasa un parámetro locale (que en este caso podría valeres
oen
) y según el locale pasado se va a generar documentación usando solo la parte del comentario que está en el lenguaje correspondiente.Si el comentario no empieza con
lang:
se asume que no tiene localización y entonces se usa completo para generar la documentación.Cómo
WollokLauncherParameters.xtend
, el locale que se pasa a elWollokDocParser
.LocalDateTime.now
), esto fue para poder testearlo más fácil.