Skip to content

Commit c4fcce1

Browse files
committed
Adds generated docs
1 parent 71b99b9 commit c4fcce1

File tree

2 files changed

+65
-1
lines changed

2 files changed

+65
-1
lines changed

.mddoc.xml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<mddoc>
2+
<docpage target="README.md" autoloader="psr0" autoloader-root="src">
3+
<section title="Dot Notation Parser">
4+
<badge-poser type="version" />
5+
<badge-poser type="downloads" />
6+
<badge-poser type="license" />
7+
<badge-travis name="QuorumCollection/DotNotationParser" />
8+
<text><![CDATA[
9+
DotNotationParser is a simple parser that will parse `foo.bar.baz` into `[ 'foo', 'bar', 'baz' ]` and `foo."bar.baz"` into `[ 'foo', 'bar.baz' ]`.
10+
11+
]]></text>
12+
<section title="Requirements">
13+
<composer-requires/>
14+
</section>
15+
<section title="Installing">
16+
<composer-install/>
17+
</section>
18+
<section title="Documentation">
19+
<file name="src/DotNotationParser.php" />
20+
</section>
21+
</section>
22+
</docpage>
23+
</mddoc>

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
1-
# DotNotationParser
1+
# Dot Notation Parser
22

3+
[![Latest Stable Version](https://poser.pugx.org/quorum/dot-notation/version)](https://packagist.org/packages/quorum/dot-notation)
4+
[![Total Downloads](https://poser.pugx.org/quorum/dot-notation/downloads)](https://packagist.org/packages/quorum/dot-notation)
5+
[![License](https://poser.pugx.org/quorum/dot-notation/license)](https://packagist.org/packages/quorum/dot-notation)
6+
[![Build Status](https://travis-ci.org/QuorumCollection/DotNotationParser.svg?branch=master)](https://travis-ci.org/QuorumCollection/DotNotationParser)
7+
8+
9+
DotNotationParser is a simple parser that will parse `foo.bar.baz` into `[ 'foo', 'bar', 'baz' ]` and `foo."bar.baz"` into `[ 'foo', 'bar.baz' ]`.
10+
11+
12+
13+
## Requirements
14+
15+
- **php**: >=7.1
16+
17+
## Installing
18+
19+
Install the latest version with:
20+
21+
```bash
22+
composer require 'quorum/dot-notation'
23+
```
24+
25+
## Documentation
26+
27+
### Class: \Quorum\DotNotation\DotNotationParser
28+
29+
Class DotPathParser
30+
31+
#### Method: DotNotationParser->parse
32+
33+
```php
34+
function parse(string $path) : array
35+
```
36+
37+
##### Parameters:
38+
39+
- ***string*** `$path`
40+
41+
##### Returns:
42+
43+
- ***string[]***

0 commit comments

Comments
 (0)