Skip to content

Docs: improvements for better rendering in PHPDocumentor #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 13, 2020
Merged

Docs: improvements for better rendering in PHPDocumentor #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions PHPCSUtils/AbstractSniffs/AbstractArrayDeclarationSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,14 @@ abstract class AbstractArrayDeclarationSniff implements Sniff
* A multi-dimentional array with information on each array item.
*
* The array index is 1-based and contains the following information on each array item:
* - 'start' : The stack pointer to the first token in the array item.
* - 'end' : The stack pointer to the last token in the array item.
* - 'raw' : A string with the contents of all tokens between `start` and `end`.
* - 'clean' : Same as `raw`, but all comment tokens have been stripped out.
* ```php
* 1 => array(
* 'start' => int, // The stack pointer to the first token in the array item.
* 'end' => int, // The stack pointer to the last token in the array item.
* 'raw' => string, // A string with the contents of all tokens between `start` and `end`.
* 'clean' => string, // Same as `raw`, but all comment tokens have been stripped out.
* )
* ```
*
* @since 1.0.0
*
Expand Down Expand Up @@ -163,7 +167,7 @@ public function register()
* Processes this test when one of its tokens is encountered.
*
* This method fills the properties with relevant information for examining the array
* and then passes off to the `processArray()` method.
* and then passes off to the {@see AbstractArrayDeclarationSniff::processArray()} method.
*
* @since 1.0.0
*
Expand Down Expand Up @@ -290,9 +294,9 @@ public function processArray(File $phpcsFile)
* @param int $openPtr The position of the array opener token in the token stack.
* @param int $closePtr The position of the array closer token in the token stack.
*
* @return true|void Returning `true` will short-circuit the sniff and stop processing.
* @return true|void Returning `TRUE` will short-circuit the sniff and stop processing.
* In effect, this means that the sniff will not examine the individual
* array items if `true` is returned.
* array items if `TRUE` is returned.
*/
public function processOpenClose(File $phpcsFile, $openPtr, $closePtr)
{
Expand Down Expand Up @@ -321,7 +325,7 @@ public function processOpenClose(File $phpcsFile, $openPtr, $closePtr)
* @param int $itemNr Which item in the array is being handled.
* 1-based, i.e. the first item is item 1, the second 2 etc.
*
* @return true|void Returning `true` will short-circuit the array item loop and stop processing.
* @return true|void Returning `TRUE` will short-circuit the array item loop and stop processing.
* In effect, this means that the sniff will not examine the double arrow, the array
* value or comma for this array item and will not process any array items after this one.
*/
Expand Down Expand Up @@ -351,7 +355,7 @@ public function processKey(File $phpcsFile, $startPtr, $endPtr, $itemNr)
* @param int $itemNr Which item in the array is being handled.
* 1-based, i.e. the first item is item 1, the second 2 etc.
*
* @return true|void Returning `true` will short-circuit the array item loop and stop processing.
* @return true|void Returning `TRUE` will short-circuit the array item loop and stop processing.
* In effect, this means that the sniff will not examine the array value or
* comma for this array item and will not process any array items after this one.
*/
Expand All @@ -374,7 +378,7 @@ public function processNoKey(File $phpcsFile, $startPtr, $itemNr)
* @param int $itemNr Which item in the array is being handled.
* 1-based, i.e. the first item is item 1, the second 2 etc.
*
* @return true|void Returning `true` will short-circuit the array item loop and stop processing.
* @return true|void Returning `TRUE` will short-circuit the array item loop and stop processing.
* In effect, this means that the sniff will not examine the array value or
* comma for this array item and will not process any array items after this one.
*/
Expand Down Expand Up @@ -403,7 +407,7 @@ public function processArrow(File $phpcsFile, $arrowPtr, $itemNr)
* @param int $itemNr Which item in the array is being handled.
* 1-based, i.e. the first item is item 1, the second 2 etc.
*
* @return true|void Returning `true` will short-circuit the array item loop and stop processing.
* @return true|void Returning `TRUE` will short-circuit the array item loop and stop processing.
* In effect, this means that the sniff will not examine the comma for this
* array item and will not process any array items after this one.
*/
Expand All @@ -426,7 +430,7 @@ public function processValue(File $phpcsFile, $startPtr, $endPtr, $itemNr)
* @param int $itemNr Which item in the array is being handled.
* 1-based, i.e. the first item is item 1, the second 2 etc.
*
* @return true|void Returning `true` will short-circuit the array item loop and stop processing.
* @return true|void Returning `TRUE` will short-circuit the array item loop and stop processing.
* In effect, this means that the sniff will not process any array items
* after this one.
*/
Expand Down
Loading