commit 0b286f08c63871166c8f901a5feda06530481bda
parent d3c18e40f0b02fbcae11b858531e3b1ca3961178
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Mon, 16 Jan 2017 11:58:04 +0100
Fix some grammar errors.
Diffstat:
1 file changed, 16 insertions(+), 12 deletions(-)
diff --git a/doc/input b/doc/input
@@ -77,6 +77,7 @@
2/ Grammar
--------------------------------------------------------------------------------
<solar-factory> ::=
+ <sun>
<items>
<items> ::=
@@ -88,7 +89,6 @@
| <material>
| <entity>
| <template>
- | <sun>
----------------------------------------
<geometry> ::=
@@ -106,7 +106,6 @@
point: <real3>
normal: <real3>
<target>
-[ <transform> ]
<target> ::=
target:
@@ -129,12 +128,12 @@
<cuboid> ::=
cuboid:
- size: <real3>
+ size: <real3*+>
<cylinder> ::=
cylinder:
- height: REAL
- radius: REAL
+ height: REAL # in ]0, INF)
+ radius: REAL # in ]0, INF)
[ slices: INTEGER ] # in [4, 4096]. Default 16
<obj> ::=
@@ -143,12 +142,12 @@
<parabol> ::=
parabol: # x^2 + y^2 - 4*focal*z = 0
- focal: REAL
+ focal: REAL # in ]0, INF)
clip: <polyclip-list>
<parabolic-cylinder> ::=
parabolic-cylinder: # y^2 - 4*focal*z = 0
- focal: REAL
+ focal: REAL # in ]0, INF)
clip: <polyclip-list>
<plane> ::=
@@ -157,8 +156,8 @@
<sphere> ::=
sphere:
- radius: REAL
-[ slices: INTEGER ] # Default 16
+ radius: REAL # in ]0, INF)
+[ slices: INTEGER ] # in [4, 4096]. Default 16
<stl> ::=
stl:
@@ -238,7 +237,7 @@
----------------------------------------
<sun> ::=
sun:
- dni: REAL # Direct Normal Irradiance in ]0, INF) */
+ dni: REAL # Direct Normal Irradiance in ]0, INF)
<spectrum>
[ <radial-angular-distribution> ]
@@ -268,13 +267,18 @@
- REAL
- REAL
+<real3*+> ::=
+ - REAL # in ]0, inf)
+ - REAL # in ]0, inf)
+ - REAL # in ]0, inf)
+
<spectrum> ::=
spectrum:
- <spectrum-data>
[ - <spectrum-data> ... ]
<spectrum-data> ::=
- wavelength: REAL
- data: REAL
+ wavelength: REAL # in [0, INF)
+ data: REAL # in [0, INF)