Skip to content

Commit 9d487c8

Browse files
committed
Update inline documentation for consistency and clarity. Adjust code formatting, correct typos, and expand usage examples for better readability.
1 parent 18de61a commit 9d487c8

File tree

5 files changed

+101
-76
lines changed

5 files changed

+101
-76
lines changed

phpdoc.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@
1818
</source>
1919
<ignore hidden="true" symlinks="true">
2020
<path>tests/**/*</path>
21-
<path>vendor/**/*</path>
2221
</ignore>
2322
</api>
2423
</version>
25-
24+
2625
<template name="vendor/saggre/phpdocumentor-markdown/themes/markdown"/>
26+
<setting name="template.urlFileExtensions" value="yes" />
2727
</phpdocumentor>

src/Mvc/Model.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
* - onValidationFails
3838
* - prepareSave
3939
* - validation
40-
* @link https://docs.phalcon.io/5.6/db-models/#events
40+
* @link https://docs.phalcon.io/5.9/db-models/#events
4141
*
4242
* {@inheritdoc} \Phalcon\Mvc\Model
4343
* @package Zemit\Mvc

src/Mvc/Model/Traits/EagerLoad.php

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ abstract public static function find($parameters = null);
2626
abstract public static function findFirst($parameters = null);
2727

2828
/**
29-
* <code>
30-
* <?php
29+
* Example:
3130
*
31+
* ```php
3232
* $limit = 100;
3333
* $offset = max(0, $this->request->getQuery('page', 'int') - 1) * $limit;
3434
*
@@ -41,8 +41,7 @@ abstract public static function findFirst($parameters = null);
4141
* foreach ($robot->parts as $part) { ... }
4242
* }
4343
* }
44-
*
45-
* </code>
44+
* ```
4645
*
4746
* @param array ...$arguments
4847
*/
@@ -169,17 +168,17 @@ protected static function findWithBy(string $forwardMethod, array $arguments): ?
169168
}
170169

171170
/**
172-
* <code>
171+
* Example:
173172
*
173+
* ```php
174174
* $manufacturer = Manufacturer::findFirstById(51);
175175
*
176176
* $manufacturer->load('Robots.Parts');
177177
*
178178
* foreach ($manufacturer->robots as $robot) {
179179
* foreach ($robot->parts as $part) { ... }
180180
* }
181-
*
182-
* </code>
181+
* ```
183182
*
184183
* @param array ...$arguments
185184
* @return ?ModelInterface

src/Support/Helper/Str/SanitizeUTF8.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class SanitizeUTF8
2323
* converting it to UTF-8, and removing invalid UTF-8 characters.
2424
*
2525
* @param string $string The input string to be sanitized.
26-
* @param string $invalidUtf8Regex A regular expression pattern to identify invalid UTF-8 characters. Default: '[^\x20-\x7E\xA0-\xFF]'.
26+
* @param string $invalidUtf8Regex A regular expression pattern to identify invalid UTF-8 characters. Default: '[^\\x20-\\x7E\\xA0-\\xFF]'.
2727
* @return string The sanitized string in UTF-8 encoding, with invalid characters removed.
2828
*/
2929
public function __invoke(string $string, string $invalidUtf8Regex = '[^\x20-\x7E\xA0-\xFF]'): string

0 commit comments

Comments
 (0)