city_generator2

commit 39eb334fdfdbeb409d120e804d1184b582d8f0e3
parent c54eda0196e7618e9052b63755afc541a74705c5
Author: Benjamin Piaud <benjamin.piaud@meso-star.com>
Date:   Tue, 17 Jan 2023 11:13:23 +0100

Merge remote-tracking branch 'refs/remotes/origin/develop' into develop

Diffstat:
M
doc/city_generator2-input.5.txt
 | 
17
+++++++++--------
M
doc/city_generator2.1.txt.in
 | 
2
+-

2 files changed, 10 insertions(+), 9 deletions(-)
diff --git a/doc/city_generator2-input.5.txt b/doc/city_generator2-input.5.txt
@@ -85,17 +85,18 @@ _______
 
 -------------------------------------
 
-<building>           ::= "  -id: " <name>
-                         "   model: " <cmode-name>
-                         "   data: " <dataset-name>
+<buildings>          ::= "  -name: " <name>
+                         "   construction_mode: " <cmode-name>
+                         "   dataset: " <dataset-name>
                          "   height: " <height>
-                         "   polygon: [" <vertices> "]" # At least 3 vertices
+                         "   footprint: [" <vertices> "]" # At least 3 vertices
 
 <name>               ::= STRING
 
-<cmode-name>         ::= "construction_Mode_0" | "construction_Mode_1"
+<cmode-name>         ::= "Construction_Mode_0" | "Construction_Mode_1"
 
-<dataset-name>       ::= STRING
+<dataset-name>       ::= STRING # The name must be found in a catalog file
+                                # with the same construction mode
 
 <height>             ::= <REAL> # in ]0, INF)
 
@@ -138,9 +139,9 @@ _______
 
 -------------------------------------
 
-<construction-mode-0> ::= "construction_mode_type: construction_Mode_0"
+<construction-mode-0> ::= "construction_mode: Construction_Mode_0"
 
-<construction-mode-1> ::= "construction_mode_type: construction_Mode_1"
+<construction-mode-1> ::= "construction_mode: Construction_Mode_1"
 
 -------------------------------------
 
diff --git a/doc/city_generator2.1.txt.in b/doc/city_generator2.1.txt.in
@@ -65,7 +65,7 @@ MANDATORY OPTIONS
 *-m* _file_::
   Read a city map file which is a text file in yaml 1.1 format containing the
   description of the ground and a list of buildings. The description of an
-  individual building include its footprint and construction mode among other
+  individual building includes its footprint and construction mode among other
   things.
   Please refer to *city_generator2-input*(5) for more information on formats.