Generación de Documentación

Documentación API PHP

La documentación API se refiere al parseo de las distintas clases php del núcleo de toba y la generación de una serie de páginas web con su referencia.

Requisitos

• Se necesita bajar la última versión de phpdoc y descomprimila en $toba_dir/php/3eros/PhpDocumentor

• Copiar el skin toba_hands ubicando en $toba_dir/php/3eros/_PhpDocumentor al directorio php/3ros/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates

Ejecución

El comando que utiliza toba para generar esta documentación es

    toba doc api

Una vez terminado se pueden analizar los warnings navegando hacia

    http://localhost/toba_editor/doc/api/errors.html

Documentación API JS

La documentación API JS se refiere al parseo de los distintos clases js propias de toba ubicadas en $toba_dir/www/js

Requisitos

• Runtime de perl (en windows recomendado ActivePerl

• Si aparece el mensaje Can't locate HTML/Template.pm in @INC. En linux ejecutar:

      perl -MCPAN -e 'install HTML::Template'
  

• En windows:

      ppm install HTML-Template
  

Ejecución

El comando que utiliza toba para generar esta documentación es

    toba doc api_js

Documentación WIKI

La documentación WIKI surge del wiki almacenado en el TRAC.

Requisitos

• Instalar Httrack

Ejecución

El comando que utiliza toba para generar esta documentación es

    toba doc wiki

Por un tema de eficiencia el comando esta cableado para trabajar sobre localhost con lo cual solo puede ser ejecutado desde paykin