PhpDocumentor

Page last edited 1 060 giorni 14 ore fa
Da wiki.betaingegneria.it.

PhpDocumentor[modifica]

Documentare un software crenado un sito web apposito in stile Javadoc. Fonte

Installare PhpDocumentor[modifica]

  marcob@jsbach:/var/www/html/aop/geab$ sudo pear install phpdocumentor
  [sudo] password for marcob: 
  WARNING: "pear/PhpDocumentor" is deprecated in favor of "phpdoc/phpdocumentor"
  Did not download optional dependencies: pear/XML_Beautifier, use --alldeps to download automatically
  pear/PhpDocumentor can optionally use package "pear/XML_Beautifier" (version >= 1.1)
  downloading PhpDocumentor-1.4.4.tgz ...
  Starting to download PhpDocumentor-1.4.4.tgz (1,534,088 bytes)
  ..............................done: 1,534,088 bytes
  install ok: channel://pear.php.net/PhpDocumentor-1.4.4

Produrre la documentazione di una classe[modifica]

  marcob@jsbach:/var/www/html/aop/geab$ phpdoc -o HTML:frames:earthli -f geab.class.php -t docs
  PHP Version 5.5.9-1ubuntu4.11
  phpDocumentor version 1.4.4
   
  Parsing configuration file phpDocumentor.ini...
  (found in /usr/share/php/data/PhpDocumentor/)...
  
  done
  Maximum memory usage setting disabled by php.ini...
  using tokenizer Parser
  ...To view errors and warnings, look at docs/errors.html
  done
  
  Parsing time: 0 seconds
  
  Conversion time: 2 seconds
  
  Total Documentation Time: 2 seconds
  done

Accedere alla documentazione prodotta[modifica]

  marcob@jsbach:/var/www/html/aop/geab$ ll docs/
  totale 80
  drwxrwxr-x 4 marcob marcob  4096 set  2 17:08 ./
  drwxr-xr-x 8 marcob marcob  4096 set  2 17:11 ../
  -rw-rw-r-- 1 marcob marcob   416 set  2 17:08 blank.html
  -rw-rw-r-- 1 marcob marcob   765 set  2 17:08 classtrees_default.html
  drwxrwxr-x 2 marcob marcob  4096 set  2 17:08 default/
  -rw-rw-r-- 1 marcob marcob 19459 set  2 17:08 elementindex_default.html
  -rw-rw-r-- 1 marcob marcob 19319 set  2 17:08 elementindex.html
  -rw-rw-r-- 1 marcob marcob  1103 set  2 17:08 errors.html
  -rw-rw-r-- 1 marcob marcob   952 set  2 17:08 index.html
  -rw-rw-r-- 1 marcob marcob  1516 set  2 17:08 li_default.html
  drwxrwxr-x 3 marcob marcob  4096 set  2 17:08 media/
  -rw-rw-r-- 1 marcob marcob   907 set  2 17:08 packages.html

Puntando il browser a (funzia solo dalla mia macchina ma sul sito ci sono gli Screenshot) ottengo la documentazione.

Dettagli sul sito.