Skip to content

Commit 4c254ef

Browse files
committed
update docs
1 parent f516a8e commit 4c254ef

24 files changed

Lines changed: 47 additions & 13 deletions

docs/README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,26 @@
11
# API Documentation
22

3-
List of classes :
3+
The main entry class is [repository](src/REPOSITORY.md).
44

5-
* [repository](REPOSITORY.md)
6-
* [node](NODE.md)
7-
* [file](FILE.md)
8-
* [namespace](NAMESPACE.md)
5+
With this class you can load and navigate between files and symbols.
6+
7+
## Generic classes
8+
9+
* [node](src/NODE.md) - This class represents a single statement node
10+
* [block](src/BLOCK.md) - This class represents a list of statements
11+
* [position](src/POSITION.md) - Meta informations about the position of a node
12+
* [comment](src/COMMENT.md) - Comment informations
13+
14+
## Nodes classes
15+
16+
* [class](src/CLASS.md)
17+
* [constant](src/CONSTANT.md)
18+
* [define](src/DEFINE.md)
19+
* [external](src/EXTERNAL.md)
20+
21+
## Blocks classes
22+
23+
* [declare](src/DECLARE.md)
24+
* [expr](src/EXPR.md)
25+
* [file](src/FILE.md)
26+
* [namespace](src/FILE.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ Represents an external link (require or include)
88

99
**Properties**
1010

11-
- `target` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | expr)** The target file to be included
11+
- `target` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | expr)** [:link:](EXPR.md) The target file to be included
1212
- `once` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** If true it's a include_once or require_once statement
1313
- `strict` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** If true then it's a require statement
14+
15+
# getTargetFile
16+
17+
Try to resolve the target statement and retrive the file
18+
19+
Returns **file** [:link:](FILE.md)
File renamed without changes.

0 commit comments

Comments
 (0)