Skip to content

jesusrodriguezg/phpDocumentor-sample

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

phpDocumentor-sample

Sample PHP function used to try phpDocumentor

This is a simple project created as classwork documentation for the Web Applications Deployment module of Web Application Development degree, teached by Diego Fernández Raposo in the IES Polígono Sur high school in Seville, Spain.

This repository includes a funcion.php file that randomizes two integer numbers into two variables $a and $b, and then passes them as arguments to a function suma(), wich adds them and return the result as an integer. Finally, the script prints the result alongside with the random values of $a and $b.

The script also contains the DocBlock info for phpDocumentor to auto-generate the documentation. The auto-generated docs/api folder is included in this repository, as well as a PDF file with the documented process followed in order to auto-generate the script's docs.


Función PHP de ejemplo usada para probar phpDocumentor

Éste es un proyecto sencillo creado como documentación para un trabajo de clase de la asignatura de Despliegue de Aplicaciones Web del ciclo formativo de Desarrollo de Aplicaciones Web, impartida por el profesor Diego Fernández Raposo en el IES Polígono Sur de Sevilla, España.

El repositorio incluye un archivo funcion.php que genera aleatoriamente dos números enteros en dos variables $a y $b, y luego los pasa como argumentos a la función suma(), que los suma y devuelve el resultado como un entero. Por último, el script imprime el resultado junto con los valores aleatorios de $a y $b.

El script también contiene el DocBlock con información para que phpDocumentor genere la documentación. La carpeta docs/api está incluida en este repositorio, así como un archivo PDF con la documentación sobre el proceso seguido para auto-generar la documentación del script.

About

Sample PHP function used to try phpDocumentor

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages