Agregar documentación específica a Joko Framework

=Agregar documentación específica a Joko Framework=

Introducción
Para la documentación especifica de los proyectos (API de la librería y proyectos de Joko) se debe documentar el código mismo de modo a poder generar Javadocs que se hostearan en la Github Page del proyecto.

Paso a paso para agregar documentación
1- Comentar el código de su proyecto en el formato usado para generar Javadocs y de forma completa (Incluir Explicación, @param por cada parámetro, @return para lo que retorna, @throws para explicar porque tira dicho error, etc.).

2- Generar nuevo Javadoc del proyecto (No se olvide de seleccionar el encoding correcto a la hora de generar! Si el proyecto está en castellano los acentos o la “ñ” no se desplegaran bien por defecto) y subir lo generado al directorio /docs en el branch “master” (Reemplazar los archivos antiguos si es una nueva versión).

3- Si su proyecto tiene habilitada su propia página de GitHub Pages se actualizará automáticamente al subir cambios a /docs, si no tiene la página habilitada haga lo siguiente: 3.1- Tener creado el directorio /docs en la raíz del proyecto con lo generado por Javadoc. 3.2- Entrar a la página de GitHub del proyecto y de la página principal ir a “Settings” y en la sección de “GitHub Pages” debe seleccionar la opción “master branch /docs folder” en el campo Source (Si no aparece la opción es porque no está la carpeta /docs en el repositorio), el link de su página será mostrado en esta sección una vez rellene el campo Source.