doc: Change formatting of block description in YAML

To keep multiple paraphrase separated, it is better to use YAML literals
that preserve new lines.

diff --git a/rpp/blocks/sfunction_ain.c b/rpp/blocks/sfunction_ain.c
index f74565318743eea8997c8923d64be4cb96e4caa7..dbd2f4e0e3b0472402365fada2e055f21528f8f8 100644 (file)
--- a/rpp/blocks/sfunction_ain.c
+++ b/rpp/blocks/sfunction_ain.c
@@ -38,7 +38,7 @@ Parameters:
   - { name: "Pin number", type: "uint8", range: "[1–12]" }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block allows to read the analog inputs on the RPP board. The
   ErrFlag should if raise `rpp_adc_update()` or `rpp_adc_get()`

diff --git a/rpp/blocks/sfunction_aout.c b/rpp/blocks/sfunction_aout.c
index bd709b18dcfddab9bab12e355e1a364823701b8e..4bee84fef4fb49884ac57d5ec30c9c2bf3171712 100644 (file)
--- a/rpp/blocks/sfunction_aout.c
+++ b/rpp/blocks/sfunction_aout.c
@@ -39,7 +39,7 @@ Parameters:
   - { name: "UseVoltage",       type: "bool"  }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   Sets the analog value of the specified analog output pin on the RPP board. If an error is detected 
   while setting the value, the ErrFlag is set high.  

diff --git a/rpp/blocks/sfunction_canreceive.c b/rpp/blocks/sfunction_canreceive.c
index 99905dcd33c5cac52ccbd5668d5fc8e9059b409f..a4682bdfc413ee9d6a3144cb09bee5f7f2ceb8d0 100644 (file)
--- a/rpp/blocks/sfunction_canreceive.c
+++ b/rpp/blocks/sfunction_canreceive.c
@@ -45,7 +45,7 @@ Parameters:
   - { name: "Mailbox number (0-31)",    type: "int8"                                                    }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block allows receiving messages from the CAN bus. It can be
   configured for any of the CAN ports (modules) CAN1, CAN2 or CAN3.

diff --git a/rpp/blocks/sfunction_cansetup.c b/rpp/blocks/sfunction_cansetup.c
index b5ae34725cb5694308582702db6ecd377b02a6ff..911d52be6967e55df353e1f36a627e831b54c722 100644 (file)
--- a/rpp/blocks/sfunction_cansetup.c
+++ b/rpp/blocks/sfunction_cansetup.c
@@ -38,7 +38,7 @@ Parameters:
   - { name: "Baud rate for CAN bus port 3 [bps]", type: "uint32", range: "1 – 10000000" }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block configures the CAN bus controllers. Exactly one CAN bus
   configuration block must be in the model if any of the CAN Receive

diff --git a/rpp/blocks/sfunction_cantransmit.c b/rpp/blocks/sfunction_cantransmit.c
index 5ccfccc30ab61dfdc8333d5d2f9669f13385d250..253cb50cf514cbc607a011f2f93a0978ec9c3436 100644 (file)
--- a/rpp/blocks/sfunction_cantransmit.c
+++ b/rpp/blocks/sfunction_cantransmit.c
@@ -41,7 +41,7 @@ Parameters:
   - { name: "Mailbox number",           type: "int8"                              }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block allows to send a message to the CAN bus. It can be
   configured for any of the CAN ports (modules) CAN1, CAN2 or CAN3.

diff --git a/rpp/blocks/sfunction_din.c b/rpp/blocks/sfunction_din.c
index 7dc89601637938e796d98cb25eecd5b7b2d89ac1..b4f60eebf2efe4b94c81e45d3c7b6fddc65420fc 100644 (file)
--- a/rpp/blocks/sfunction_din.c
+++ b/rpp/blocks/sfunction_din.c
@@ -41,7 +41,7 @@ Parameters:
   - { name: "Active",                 type: "Choice from Active or Tri-stated" }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block allows to read the digital inputs on the RPP board. For pins number 0-7 is not
   relevant and not visible parameter 'Use variable threshold' and only one block for each pin

diff --git a/rpp/blocks/sfunction_dinc.c b/rpp/blocks/sfunction_dinc.c
index 2a94bb0ffe6d568b691f08996bcea3659d6e4406..5104409492dd331f0fb6a0e1e50ede6014b44d46 100644 (file)
--- a/rpp/blocks/sfunction_dinc.c
+++ b/rpp/blocks/sfunction_dinc.c
@@ -37,7 +37,7 @@ Parameters:
   - { name: "Reference voltage for pins 12-15 [0-4095]", type: "uint16" }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block allows one to set reference voltage (threshold) for DIN pins. The block have two parameters,
   one for pins 8 - 11 and the other for pins 12 - 15.

diff --git a/rpp/blocks/sfunction_frayconfig.c b/rpp/blocks/sfunction_frayconfig.c
index 434943baab50d44cabe8c90b068378a8153bf0bb..48eb7bbde3a00ab96e2779d92076ca639f7bd159 100644 (file)
--- a/rpp/blocks/sfunction_frayconfig.c
+++ b/rpp/blocks/sfunction_frayconfig.c
@@ -89,7 +89,7 @@ Parameters:
   - { name: "secureBuffers",                     type: "uint8"  }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block ...
 

diff --git a/rpp/blocks/sfunction_frayreceive.c b/rpp/blocks/sfunction_frayreceive.c
index 3982ed8ae9cf7af4d2dbe9e4ba1fe2dec21a8e2b..69e11685be92dc3c76281c43880549dd58074aeb 100644 (file)
--- a/rpp/blocks/sfunction_frayreceive.c
+++ b/rpp/blocks/sfunction_frayreceive.c
@@ -46,7 +46,7 @@ Parameters:
   - { name: "slotId", type: "uint32" }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block ...
 

diff --git a/rpp/blocks/sfunction_fraysbc.c b/rpp/blocks/sfunction_fraysbc.c
index d39932324732af6d1001b1e60ed72ebb24de4b39..79459fb67260d6b253502b94085f15c075b1740e 100644 (file)
--- a/rpp/blocks/sfunction_fraysbc.c
+++ b/rpp/blocks/sfunction_fraysbc.c
@@ -35,7 +35,7 @@ Outputs:
 Parameters:
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block ...
 

diff --git a/rpp/blocks/sfunction_fraytransmit.c b/rpp/blocks/sfunction_fraytransmit.c
index b45406ec74eec3214c466bfe1ba963e8c064979f..e16cd27d90a80e972d70a3b9ad39368120df5737 100644 (file)
--- a/rpp/blocks/sfunction_fraytransmit.c
+++ b/rpp/blocks/sfunction_fraytransmit.c
@@ -44,7 +44,7 @@ Parameters:
   - { name: "slotId", type: "uint32" }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block ...
 

diff --git a/rpp/blocks/sfunction_hbr.c b/rpp/blocks/sfunction_hbr.c
index 4239c64614c935290d878357d5b7bf48b4b0f988..754e94fb27bd93e3f6e80973dc6e78e96fef966f 100644 (file)
--- a/rpp/blocks/sfunction_hbr.c
+++ b/rpp/blocks/sfunction_hbr.c
@@ -38,7 +38,7 @@ Outputs:
 Parameters:
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block allows to control the H-Bridge on the RPP board. The ErrFlag should raise only if
   `rpp_hbr_control()` returns error. The H-Bridge is initialized with the default frequency 

diff --git a/rpp/blocks/sfunction_irc.c b/rpp/blocks/sfunction_irc.c
index 437107ce7406f2c5a7c46b1dbde32b93ab3a2729..e253454ce27420bc2b3f13ca0d74fff72f0aab91 100644 (file)
--- a/rpp/blocks/sfunction_irc.c
+++ b/rpp/blocks/sfunction_irc.c
@@ -38,7 +38,7 @@ Parameters:
   - { name: "IRC number [1-2]", type: "uint8" }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block allows to read a value of an IRC sensors. Two
   configurations are supported: IRC is connected to pins DIN10 and DIN11

diff --git a/rpp/blocks/sfunction_lout.c b/rpp/blocks/sfunction_lout.c
index db77a20970bb88952a9381e8e035b91282fd4f9f..32993db840aecf0ada88cc17f193c86cc3471c55 100644 (file)
--- a/rpp/blocks/sfunction_lout.c
+++ b/rpp/blocks/sfunction_lout.c
@@ -38,7 +38,7 @@ Parameters:
   - { name: "Pin number [1-8]", type: "uint8" }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block allows to write to the digital outputs on the RPP board. The ErrFlag should raise if 
   `rpp_lout_set()` or `rpp_lout_update()` returns error. Because the ErrFlag should never set, 

diff --git a/rpp/blocks/sfunction_mout.c b/rpp/blocks/sfunction_mout.c
index 0d6a72c33d103fc9d02eb60d3c8df3079d528f68..82d26aa55f104f02491eec8dfed560f77f6e6a56 100644 (file)
--- a/rpp/blocks/sfunction_mout.c
+++ b/rpp/blocks/sfunction_mout.c
@@ -38,7 +38,7 @@ Parameters:
   - { name: "Pin number [1-6]", type: "uint8" }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block allows to write the power outputs (2A) on the RPP board. The ErrFlag should raise only 
   if `rpp_mout_set()` returns error. Note that `rpp_mout_set()` returns error only if some bad 

diff --git a/rpp/blocks/sfunction_ovrn.c b/rpp/blocks/sfunction_ovrn.c
index 2fa464d6adc38c14aecf7dc839e4f0eb93ea2f3f..aedf8f7bf37b75b74d2dab7aee13d91af9bcae56 100644 (file)
--- a/rpp/blocks/sfunction_ovrn.c
+++ b/rpp/blocks/sfunction_ovrn.c
@@ -34,7 +34,7 @@ Outputs:
 Parameters:
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block triggers connected simulink function subsystems in case that
   previous loop took more time than simulation time is set.

diff --git a/rpp/blocks/sfunction_scic.c b/rpp/blocks/sfunction_scic.c
index 199e02e169163de97fbebe3cc203c312f1f741c2..32ae9af4c0fff0e5770a1d445341392e8bf1a5a0 100644 (file)
--- a/rpp/blocks/sfunction_scic.c
+++ b/rpp/blocks/sfunction_scic.c
@@ -36,7 +36,7 @@ Parameters:
   - { name: "Baud rate", type: "uint32" }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block allows to configure the baud rate of the SCI. There should be only one block of this type 
   per model, and this requirement is validated.

diff --git a/rpp/blocks/sfunction_scip.c b/rpp/blocks/sfunction_scip.c
index e01d46bd90fcd988e118fe2761b121d9d946d1c0..62f205af779ce73f00fcd17323d42a69a232b25b 100644 (file)
--- a/rpp/blocks/sfunction_scip.c
+++ b/rpp/blocks/sfunction_scip.c
@@ -38,7 +38,7 @@ Parameters:
   - { name: "PrintFormat [SETTING]", type: "string" }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block allows to print a formatted string to the SCI. The PrintFormat
   string parameters SETTING is used as the format specifier. Note that this value is

diff --git a/rpp/blocks/sfunction_scir.c b/rpp/blocks/sfunction_scir.c
index 01e862d1f0309b88f9532af5b2ae49f4baa37221..df574dfbbe8e825ef57a4063741058d99548037b 100644 (file)
--- a/rpp/blocks/sfunction_scir.c
+++ b/rpp/blocks/sfunction_scir.c
@@ -37,7 +37,7 @@ Outputs:
 Parameters:
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block allows to receive a byte from the SCI. The ErrFlag should raise if `rpp_sci_read_nb()`
   doesn't succeed. The behavior of the ErrFlag is different from others blocks in that this block 

diff --git a/rpp/blocks/sfunction_scis.c b/rpp/blocks/sfunction_scis.c
index f433e6d35fc0585e3b8998d7ff979e23057339e0..0371700d42aecc68e1de0fab13ffe66ca0671e22 100644 (file)
--- a/rpp/blocks/sfunction_scis.c
+++ b/rpp/blocks/sfunction_scis.c
@@ -37,7 +37,7 @@ Outputs:
 Parameters:
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block allows to send a byte to the SCI.
 

diff --git a/rpp/blocks/sfunction_sdrw.c b/rpp/blocks/sfunction_sdrw.c
index 4e44a4ccf0e2225bba4c154a6a94b5b49cff00c2..27a2d151e0c0ec16b28379ada63d1957f4681b73 100644 (file)
--- a/rpp/blocks/sfunction_sdrw.c
+++ b/rpp/blocks/sfunction_sdrw.c
@@ -39,7 +39,7 @@ Parameters:
   - { name: "PrintFormat [SETTING]", type: "string" }
 
 # Description is in Markdown mark-up
-Description: >
+Description: |
 
   This block allows to log a double value to the SD-RAM. User needs to provide a valid PrintFormat 
   string to format and register the double value on the log. The PrintFormat string should include