Documentar en PHP con ApiGen usando Netbeans 7.3 en Linux

ApiGen es una herramienta para PHP que documenta las clases de nuestro proyecto de una forma muy parecida al Javadoc de Java. También existe phpDocumentor, pero probando ambas me quedé finalmente con ApiGen que tiene una interfaz, a mi gusto, mucho mas rápida para acceder a la información de las clases.

Para instalarla, abrimos una consola con el usuario root y tipeamos:

# pear config-set auto_discover 1
# pear install pear.apigen.org/apigen

Si no quieren usar el autodiscover de pear, la opción alternativa sería:

# pear channel-discover pear.apigen.org
# pear channel-discover pear.nette.org
# pear channel-discover pear.texy.info
# pear channel-discover pear.kukulich.cz
# pear channel-discover pear.andrewsville.cz
# pear install apigen/ApiGen

Pero yo les recomiendo usar autodiscover, ya que la instalación es más sencilla de esa manera. Ahora hacemos click izquierdo en nuestro proyecto PHP en Netbeans y nos vamos a Generate documentation > ApiGen. Si no nos genera la documentación automáticamente nos va a aparecer una ventana donde tendremos que decirle la ruta del script generador de ApiGen. Hacemos click en search. A mí que uso Lubuntu me sugiere la ruta /usr/bin/apigen. La ruta podría llegar a variar dependiendo de la distro de Linux que estén usando, si search no funciona, ejecuten este comando para encontrar la ruta:

# whereis apigen
apigen: /usr/bin/apigen /usr/bin/X11/apigen