# Manual técnico - Sincronizador

En este documento se expone como configurar los tests de PHPUnit y la documentacion del proyecto mediante PHPDocumentor.
## 1. Configuración de tests

Los tests requieren un usuario y un administrador de prueba válido en la base de datos `sincronizador`. Asegúrese de que
las variables `TEST_USER_LOGIN`, `TEST_USER_PASS`, `TEST_ADMIN_LOGIN` y `TEST_ADMIN_PASS` del `.env` correspondan a
usuarios reales y activos.

Para ejecutar todos los tests:

```powershell
php backend/vendor/bin/phpunit -c backend/phpunit.xml
```

Para ejecutar una suite concreta:

```powershell
php backend/vendor/bin/phpunit -c backend/phpunit.xml --testsuite Auth
php backend/vendor/bin/phpunit -c backend/phpunit.xml --testsuite Users
php backend/vendor/bin/phpunit -c backend/phpunit.xml --testsuite Layouts
```
No hay que preocuparse de la generación de basura dentro de la base de datos. Todos los tests limpian cualquier
alteracion dentro de las base de datos.

---

## 2. Generación de documentación

La documentación del código se genera con **PHPDocumentor**, ya incluido en el proyecto.

1. Abre una terminal en la raíz del proyecto.
2. Ejecuta:

```powershell
php backend/vendor/bin/phpdoc -c phpdoc.xml
```

3. La documentación se genera en `ProyectoSincro/docs/phpDocumentor/`.
4. Ábrela en el navegador accediendo a `docs/phpDocumentor/index.html`.

> Para añadir o modificar las directrices de generación, edita `phpdoc.xml` en la raíz del proyecto.  
> Consulta la [guía oficial de PHPDocumentor](https://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html)
> para mantener coherencia entre versiones.