Skip to content

Commit 28d823a

Browse files
author
Filippo Conti
committed
Added tutorials and refs in code comments
1 parent 82b2174 commit 28d823a

File tree

6 files changed

+2132
-1
lines changed

6 files changed

+2132
-1
lines changed

src/ast.js

+1
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ const Position = require("./ast/position");
104104
/**
105105
* The AST builder class
106106
* @constructor AST
107+
* @tutorial AST
107108
* @property {Boolean} withPositions - Should locate any node (by default false)
108109
* @property {Boolean} withSource - Should extract the node original code (by default false)
109110
*/

src/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ function combine(src, to) {
3838
* Initialise a new parser instance with the specified options
3939
*
4040
* @class
41-
*
41+
* @tutorial Engine
4242
* @example
4343
* var parser = require('php-parser');
4444
* var instance = new parser({

src/parser.js

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ function isNumber(n) {
1616
* The PHP Parser class that build the AST tree from the lexer
1717
*
1818
* @class
19+
* @tutorial Parser
1920
* @property {Lexer} lexer - current lexer instance
2021
* @property {AST} ast - the AST factory instance
2122
* @property {Integer|String} token - current token

0 commit comments

Comments
 (0)