Skip to content

Commit 32bc232

Browse files
committed
Added docs for the parser
1 parent b3eaa4d commit 32bc232

5 files changed

Lines changed: 92 additions & 1 deletion

File tree

4.02 KB
Loading
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2+
<diagram program="umlet" version="14.2">
3+
<zoom_level>10</zoom_level>
4+
<element>
5+
<id>UMLClass</id>
6+
<coordinates>
7+
<x>320</x>
8+
<y>110</y>
9+
<w>100</w>
10+
<h>70</h>
11+
</coordinates>
12+
<panel_attributes>bg=orange
13+
/Parser/
14+
-
15+
16+
-
17+
+parse(): int
18+
</panel_attributes>
19+
<additional_attributes/>
20+
</element>
21+
<element>
22+
<id>UMLClass</id>
23+
<coordinates>
24+
<x>320</x>
25+
<y>220</y>
26+
<w>100</w>
27+
<h>70</h>
28+
</coordinates>
29+
<panel_attributes>bg=yellow
30+
PlyParser
31+
-
32+
33+
-
34+
</panel_attributes>
35+
<additional_attributes/>
36+
</element>
37+
<element>
38+
<id>UMLClass</id>
39+
<coordinates>
40+
<x>320</x>
41+
<y>330</y>
42+
<w>100</w>
43+
<h>70</h>
44+
</coordinates>
45+
<panel_attributes>bg=yellow
46+
DiceParser
47+
-
48+
49+
-
50+
</panel_attributes>
51+
<additional_attributes/>
52+
</element>
53+
<element>
54+
<id>Relation</id>
55+
<coordinates>
56+
<x>360</x>
57+
<y>170</y>
58+
<w>30</w>
59+
<h>70</h>
60+
</coordinates>
61+
<panel_attributes>lt=&lt;&lt;-</panel_attributes>
62+
<additional_attributes>10.0;10.0;10.0;50.0</additional_attributes>
63+
</element>
64+
<element>
65+
<id>Relation</id>
66+
<coordinates>
67+
<x>360</x>
68+
<y>280</y>
69+
<w>30</w>
70+
<h>70</h>
71+
</coordinates>
72+
<panel_attributes>lt=&lt;&lt;-</panel_attributes>
73+
<additional_attributes>10.0;10.0;10.0;50.0</additional_attributes>
74+
</element>
75+
</diagram>

docs/source/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,8 @@
118118
('Usage', './usage.html'),
119119
('Dice model', './docs/dice.html'),
120120
('Grammar', './docs/grammar.html'),
121-
('Notation', './docs/notation.html')]),
121+
('Notation', './docs/notation.html'),
122+
('Parser', './docs/parser.html')]),
122123
('Info and Reports', [('Reports', './reports.html'),
123124
('Code docs', './code/index.html')])],
124125
}

docs/source/docs/parser.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
======
2+
Parser
3+
======
4+
5+
.. image:: ../_static/diagram/parser_class_diagram.png
6+
:alt: Parser class diagram
7+
8+
The DiceParser is capable of transforming dice notation expressions into the
9+
dice notation model.
10+
11+
It is based on Ply, and contains all the rules defined in itself.
12+
13+
The classes it extends over are just meant to allow extensions, not to be used
14+
by themselves.

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,4 @@ Features
2727
docs/dice
2828
docs/grammar
2929
docs/notation
30+
docs/parser

0 commit comments

Comments
 (0)