Building better documentation (#5)

.gitignore

@@ -4,3 +4,4 @@ composer.lock
 .phpunit.result.cache
 .phpunit.cache
 /var/
+/.phpdoc/

README.md

@@ -27,6 +27,23 @@ Find the package on [packagist.org](https://packagist.org/packages/pseudo/pseudo
 
 https://pseudo-pdo.org
 
+### Documentation Generation
+
+This project uses [readthedocs](https://readthedocs.io) and [mkdocs](https://mkdocs.org)
+
+To load the local documentation page setup mkdocs locally and run:
+```shell
+$ mkdocs serve
+```
+
+You can edit the `mkdocs.yaml` file to change the pages that show up in the sidebar.
+
+To generate the docs, setup [phpDocumentor](https://phpdoc.org/) locally and then run:
+
+```shell
+$ phpdoc --directory=src --target=docs --template="vendor/saggre/phpdocumentor-markdown/themes/markdown"
+```
+
 ## Installation
 
 ```

composer.json

@@ -24,7 +24,8 @@
     "require-dev": {
         "phpunit/phpunit": "^9.6|^10.5|^11.3",
         "phpunit/php-code-coverage": "^9.2|^10.1|^11.0",
-        "phpstan/phpstan": "^1.12"
+        "phpstan/phpstan": "^1.12",
+        "saggre/phpdocumentor-markdown": "^0.1.4"
     },
     "autoload": {
         "psr-4": {

docs/Home.md

@@ -0,0 +1,44 @@
+
+***
+
+# phpDocumentor
+
+
+
+This is an automatically generated documentation for **phpDocumentor**.
+
+
+## Namespaces
+
+
+### \Pseudo
+
+#### Classes
+
+| Class | Description |
+|-------|-------------|
+| [`ParsedQuery`](./classes/Pseudo/ParsedQuery.md) | |
+| [`Pdo`](./classes/Pseudo/Pdo.md) | |
+| [`PdoStatement`](./classes/Pseudo/PdoStatement.md) | |
+| [`QueryLog`](./classes/Pseudo/QueryLog.md) | |
+| [`Result`](./classes/Pseudo/Result.md) | |
+| [`ResultCollection`](./classes/Pseudo/ResultCollection.md) | |
+
+
+
+
+### \Pseudo\Exceptions
+
+#### Classes
+
+| Class | Description |
+|-------|-------------|
+| [`LogicException`](./classes/Pseudo/Exceptions/LogicException.md) | |
+| [`PseudoException`](./classes/Pseudo/Exceptions/PseudoException.md) | |
+| [`PseudoPdoException`](./classes/Pseudo/Exceptions/PseudoPdoException.md) | |
+
+
+
+
+***
+> Automatically generated on 2024-10-12

docs/classes/Pseudo/Exceptions/LogicException.md

@@ -0,0 +1,18 @@
+***
+
+# LogicException
+
+
+
+
+
+* Full name: `\Pseudo\Exceptions\LogicException`
+* Parent class: [`\Pseudo\Exceptions\PseudoException`](./PseudoException.md)
+
+
+
+
+
+
+***
+> Automatically generated on 2024-10-12

docs/classes/Pseudo/Exceptions/PseudoException.md

@@ -0,0 +1,18 @@
+***
+
+# PseudoException
+
+
+
+
+
+* Full name: `\Pseudo\Exceptions\PseudoException`
+* Parent class: [`Exception`](../../Exception.md)
+
+
+
+
+
+
+***
+> Automatically generated on 2024-10-12

docs/classes/Pseudo/Exceptions/PseudoPdoException.md

@@ -0,0 +1,18 @@
+***
+
+# PseudoPdoException
+
+
+
+
+
+* Full name: `\Pseudo\Exceptions\PseudoPdoException`
+* Parent class: [`PDOException`](../../PDOException.md)
+
+
+
+
+
+
+***
+> Automatically generated on 2024-10-12

docs/classes/Pseudo/ParsedQuery.md

@@ -0,0 +1,147 @@
+***
+
+# ParsedQuery
+
+
+
+
+
+* Full name: `\Pseudo\ParsedQuery`
+
+
+
+## Properties
+
+
+### rawQuery
+
+
+
+```php
+private string $rawQuery
+```
+
+
+
+
+
+
+***
+
+### hash
+
+
+
+```php
+private string $hash
+```
+
+
+
+
+
+
+***
+
+## Methods
+
+
+### __construct
+
+
+
+```php
+public __construct(string $query): mixed
+```
+
+
+
+
+
+
+
+
+**Parameters:**
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `$query` | **string** |  |
+
+
+
+
+
+***
+
+### isEqualTo
+
+
+
+```php
+public isEqualTo(\Pseudo\ParsedQuery|string $query): bool
+```
+
+
+
+
+
+
+
+
+**Parameters:**
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `$query` | **\Pseudo\ParsedQuery|string** |  |
+
+
+
+
+
+***
+
+### getHash
+
+
+
+```php
+public getHash(): string
+```
+
+
+
+
+
+
+
+
+
+
+
+
+***
+
+### getRawQuery
+
+
+
+```php
+public getRawQuery(): string
+```
+
+
+
+
+
+
+
+
+
+
+
+
+***
+
+
+***
+> Automatically generated on 2024-10-12