Avances en Documentación y Código

Publicado por Sir Gon | 12 de Julio del 2007 - 1:56 pm
En desarrollo, documentacion |

Desde hace un tiempo se ha estado completando la documentación de la API.

Las novedades son:

Aparecen TODAS las clases.
Muchas de los métodos cuentan con un ejemplo.
Se han preservado las imágenes de la documentación antigua.
Se muestran los métodos heredados.
Completos diagramas de herencia entre clases.

Antes sin darme cuenta, la documentación no mostraba los módulos opcionales que se compilan cuando se pasan parámetros especiales. Ahora se arregló el Doxyfile para que documente los módulos opcionales. Como documentar implica tocar el código, también se han mejorado ciertas cosas:

Los nombres de los parámetros ahora son los mismos en todos los métodos heredados.
Se han dejado como “opcionales” los módulos que dependen de librerías que no sea Irrlicht, así si alguien tiene problemas, no tiene instaladas las dependencias o decide no ocupar esas librerías (por ejemplo Openal, Lua, …) puede compilar sin ellas. Para compilar con las librerías externas, es necesario pasar los parámetros al compilador:
- _GDT_SONIDO_ // Openal + Alut
- _GDT_SONIDO_OGG_ // OGG + Vorbis
- _GDT_MIDI_ // WINAPI (el midi funciona solo con la winapi por ahora), desactivado en Linux (por razones obvias) y en MS Visual C++ 2005 Express (porque necesita el Platform SDK).
- _GDT_SCRIPTING_ // LUA
- _GDT_FISICAS_NEWTON_ // Newton Dynamics, desactivado en forma predeterminada
- _GDT_FISICAS_ODE_ // NO implementado aun, pero irá a futuro.
Los proyectos para CMake, Dev-C++ y MS Visual C++ 2005 Express estarán pre-configurados con estos parámetros.
Se ha agregado un hack en cada archivo de cabecera (.h) para que funcionen los métodos al compilar GDT como .dll en Visual C++. Este “Hack” es un #define que ha sido nombrado _GDT_EXPORT_, el cual es totalmente inocuo en compiladores los demás compiladores. Esto permite que los métodos declarados con este define serán “visibles” desde un programa que enlace con la librería. Si lo ven en la documentación y causa extrañeza, simplemente deben ignorarlo.
Se han cambiado la estructura de los directorios en el código fuente. básicamente es igual que antes, pero ahora cada plataforma tiene su propia carpeta de binarios, así los ejecutables hechos con GCC no se mezclaran con los de Visual C++, ni con los de Mingw.
Los demos en vez de números, tendrán como prefijo gdt_, así por ejemplo “01_mallas” será “gdt_mallas”, 02_luces “gdt_luces”. Esto se me ocurrió porque eventualmente se podrían hacer más demos, y los números en realidad no demostraban ninguna relación.

Y lo que falta por hacer:

Terminar de documentar todos los módulos.
Arreglar dependencia de OGG al compilar con MS Visual C++ 2005 Express.
Arreglar todos los parámetros para los proyectos de Dev-C++, incluyendo cada demo. Además de cambiarle los nombres a los ejecutables
Hacer que los proyectos de cada IDE/plataforma construya los objetos en alguna carpeta especial, para evitar ensuciar los directorios.
Hacer un proyecto para Code::Blocks
Implementar ODE. Astucia publicó un avance, que aun no se incluye ni he probado.
Evaluar los cambios, probar todo, y empaquetar una nueva versión. ¿Serán todos estos cambios suficientes como cambiar el número a una versión mayor?

A medida que ocurran cambios significativos, se publicaran en el repositorio SVN como siempre.