viernes, 6 de enero de 2017

Cómo generar la documentación de referencia sobre el API de DirectFB


DirectFB (Direct Frame Buffer) es una librería gráfica ligera (adecuada para sistemas empotrados). Proporciona aceleración de los gráficos, control de los dispositivos de entrada, ventanas traslúcidas, visualización por capas, etc.


La página oficial de DirectFB está caída (a fecha de julio 2016): http://www.directfb.org/


Desde el Archivo de Internet:
https://web.archive.org/web/20101215114416/http://directfb.org/


Pero también podemos generar la documentación desde el código fuente:

Denis Kropp es un desarrollador de DirectFB (vamos a descargar el código de su repositorio):
$ git clone https://github.com/deniskropp/DirectFB

Como estoy interesado en la doc de la rama 1.4 cambio hacia ella:
$ git checkout -b directfb-1.4 origin/directfb-1.4
Branch directfb-1.4 set up to track remote branch directfb-1.4 from origin.
Switched to a new branch 'directfb-1.4'


$ git branch
* directfb-1.4
master



Del fichero README (traducido):
Documentación
-------------

   Durante el proceso de compilado se generará en el directorio docs la 
   documentación completa de referencia sobre el API, en formato HTML.
   También se puede acceder a la referencia del API así como a una introducción,
   tutoriales, y el FAQ online en http://www.directfb.org/documentation/.

Generamos el fichero configure:
$ ./autogen.sh


Para generar la documentación del API en formato HTML:
$ make html
make -C docs/html
make[1]: Entering directory 'directFB/DirectFB/docs/html'
rootme=`pwd`; \
/usr/bin/perl ../../tools/gendoc.pl DirectFB 1.4.16 ../../include/directfb.h ../../include/directfb_keyboard.h ../../include/directfbgl.h \
&& echo timestamp $rootme/stamp-docs
make[1]: Leaving directory 'directFB/DirectFB/docs/html'



Puedes visualizar la documentación HTML con tu navegador preferido:
$ firefox DirectFB/docs/html/IDirectFB.html


TRADUCIDO DE:

How to generate API reference documentation for DirectFB


No hay comentarios:

Publicar un comentario