tarea: comentar php doc en codigo fuente
auqnue yo voy hacer wiki y documentacion necesitamos la api doc generada,
si en los codigos fuentes se coloca la documentacion correctamnte .. mi pretencion es usar https://github.com/victorjonsson/PHP-Markdown-Documentation-Generator/network para generar la documentacion del api en formato markdown, e inclusive en un futuro implementar ese proyecto en (php)guachi incluido.. esta herramienta no depende de internet, las demas si de paso no requiere mas que php y ya
sea como sea los codigos fuentes deben tener documentacion en los headers: siguiendo estandar en http://www.phpdoc.org/
dejar abierta esta tarea
ejemplo:
/**
* no mas de 40 caracteres no mas de 4 lineas
*/
class nombreCamelCase {
/**
* no mas de 80 caracteres no mas de 2 lineas
* @param string $str no mas de 20 caracteres descripcion
* @param array $arr no mas de 20 caracteres descripcion
* @return <__CLASS__>\objeto/metodo (al hacer esto no necesita descripcion, enlaza directo)
*/
function funcion($str, $arr=array()) {
}
}