apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: Comment

Source Location: /PHP_CodeSniffer-3.1.1/src/Tokenizers/Comment.php

Class Overview


Tokenizes doc block comments.


Author(s):

Copyright:

  • 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)

Methods


Inherited Variables

Inherited Methods


Class Details

[line 14]
Tokenizes doc block comments.


[ Top ]


Method Detail

tokenizeString   [line 30]

array tokenizeString( string $string, string $eolChar, int $stackPtr)

Creates an array of tokens when given some PHP code.

Starts by using token_get_all() but does a lot of extra processing to insert information about the context of the token.

  • Access: public

Parameters:

string   $string   —  The string to tokenize.
string   $eolChar   —  The EOL character to use for splitting strings.
int   $stackPtr   —  The position of the first token in the file.

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:27:18 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.