]> rtime.felk.cvut.cz Git - jenkicar/rpp-simulink.git/commitdiff
doc: Use a more compact syntax to document input, outputs and parameters
authorMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 28 Aug 2014 17:21:07 +0000 (19:21 +0200)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 28 Aug 2014 17:21:07 +0000 (19:21 +0200)
19 files changed:
rpp/blocks/sfunction_ain.c
rpp/blocks/sfunction_aout.c
rpp/blocks/sfunction_canreceive.c
rpp/blocks/sfunction_cansetup.c
rpp/blocks/sfunction_cantransmit.c
rpp/blocks/sfunction_din.c
rpp/blocks/sfunction_dinc.c
rpp/blocks/sfunction_frayconfig.c
rpp/blocks/sfunction_frayreceive.c
rpp/blocks/sfunction_fraytransmit.c
rpp/blocks/sfunction_hbr.c
rpp/blocks/sfunction_irc.c
rpp/blocks/sfunction_lout.c
rpp/blocks/sfunction_mout.c
rpp/blocks/sfunction_scic.c
rpp/blocks/sfunction_scip.c
rpp/blocks/sfunction_scir.c
rpp/blocks/sfunction_scis.c
rpp/blocks/sfunction_sdrw.c

index f6ffd44728f616569f85db40e5c72f6a1fd4d804..f74565318743eea8997c8923d64be4cb96e4caa7 100644 (file)
@@ -31,15 +31,11 @@ Mnemonic: ADC
 Inputs:
 
 Outputs:
-  - name: Analog Input Pin Number
-    type: uint16
-  - name: ErrFlag
-    type: bool
+  - { name: "Analog Input Pin Number", type: "uint16" }
+  - { name: "ErrFlag",                 type: "bool"   }
 
 Parameters:
-  - name: Pin number
-    type: uint8
-    range: "[1–12]"
+  - { name: "Pin number", type: "uint8", range: "[1–12]" }
 
 # Description is in Markdown mark-up
 Description: >
index 2d9880106d1bee713db1e5b33f2d181631de58bb..bd709b18dcfddab9bab12e355e1a364823701b8e 100644 (file)
@@ -29,18 +29,14 @@ Header: rpp/adc.h
 Mnemonic: DAC
 
 Inputs:
-  - name: Analog Output
-    type: uint16
+  - { name: "Analog Output", type: "uint16" }
 
 Outputs:
-  - name: ErrFlag
-    type: bool
+  - { name: "ErrFlag", type: "bool" }
 
 Parameters:
-  - name: Pin number [1-4]
-    type: uint8
-  - name: UseVoltage
-    type: bool
+  - { name: "Pin number [1-4]", type: "uint8" }
+  - { name: "UseVoltage",       type: "bool"  }
 
 # Description is in Markdown mark-up
 Description: >
index 30bb5e4bb98f259e16050bb865430014a61666e1..0aed6bd09953127f0f69e2b9a2c07708c09d157b 100644 (file)
@@ -31,32 +31,18 @@ Mnemonic: CANR
 Inputs:
 
 Outputs:
-  - name: f()
-    type: Function call
-  - name: Msg
-    type: uint8, uint16, uint32 or CAN MESSAGE
+  - { name: "f()", type: "Function call"                        }
+  - { name: "Msg", type: "uint8, uint16, uint32 or CAN MESSAGE" }
 
 Parameters:
-  - name: Module
-    type: Choice
-    range: CAN1, CAN2, CAN3
-  - name: Message type
-    type: Choice
-    range: Standard, Extended, Mixed
-  - name: Message filter
-    type: Choice
-    range: Single ID, ID & mask
-  - name: Message ID
-    type: uint32
-  - name: Message ID mask
-    type: uint8
-  - name: Data type
-    type: Choice
-    range: uint8, uint16, uint32, CAN MESSAGE TYPE
-  - name: Automatic mailbox number
-    type: bool
-  - name: Mailbox number (0-31)
-    type: uint8
+  - { name: "Module",                   type: "Choice", range: "CAN1, CAN2, CAN3"                        }
+  - { name: "Message type",             type: "Choice", range: "Standard, Extended, Mixed"               }
+  - { name: "Message filter",           type: "Choice", range: "Single ID, ID & mask"                    }
+  - { name: "Message ID",               type: "uint32"                                                   }
+  - { name: "Message ID mask",          type: "uint8"                                                    }
+  - { name: "Data type",                type: "Choice", range: "uint8, uint16, uint32, CAN MESSAGE TYPE" }
+  - { name: "Automatic mailbox number", type: "bool"                                                     }
+  - { name: "Mailbox number (0-31)",    type: "uint8"                                                    }
 
 # Description is in Markdown mark-up
 Description: >
index d8c466a46ecd728f01a88e58bee896193e04ba70..2d712be96f60eeb4e656c55dc7e8c5914b210af0 100644 (file)
@@ -33,15 +33,9 @@ Inputs:
 Outputs:
 
 Parameters:
-  - name: Baud rate for CAN bus port 1 [bps]
-    type: uint32
-    range: 1 – 10000000
-  - name: Baud rate for CAN bus port 2 [bps]
-    type: uint32
-    range: 1 – 10000000
-  - name: Baud rate for CAN bus port 3 [bps]
-    type: uint32
-    range: 1 – 10000000
+  - { name: "Baud rate for CAN bus port 1 [bps]", type: "uint32", range: "1 – 10000000" }
+  - { name: "Baud rate for CAN bus port 2 [bps]", type: "uint32", range: "1 – 10000000" }
+  - { name: "Baud rate for CAN bus port 3 [bps]", type: "uint32", range: "1 – 10000000" }
 
 # Description is in Markdown mark-up
 Description: >
index dc51e0f331fd83f4dde2322dea0339cc6a9f05a4..1e7ae31c310ebf63a5d71c58c7f3fc40ef2d534b 100644 (file)
@@ -29,24 +29,16 @@ Header: rpp/can.h
 Mnemonic: CANT
 
 Inputs:
-  - name: Msg
-    type: dynamically
+  - { name: "Msg", type: "dynamically" }
 
 Outputs:
 
 Parameters:
-  - name: Module
-    type: Choise
-    range: CAN1, CAN2, CAN3
-  - name: Message type
-    type: Choise
-    range: Standard, Extended
-  - name: Message ID
-    type: uint16
-  - name: Automatic mailbox number
-    type: bool
-  - name: mailbox id
-    type: uint32
+  - { name: "Module",                   type: "Choise", range: "CAN1, CAN2, CAN3"   }
+  - { name: "Message type",             type: "Choise", range: "Standard, Extended" }
+  - { name: "Message ID",               type: "uint16"                              }
+  - { name: "Automatic mailbox number", type: "bool"                                }
+  - { name: "mailbox id",               type: "uint32"                              }
 
 # Description is in Markdown mark-up
 Description: >
index 60c340721458387c13c423d9ca25805b1beffa39..7dc89601637938e796d98cb25eecd5b7b2d89ac1 100644 (file)
@@ -31,20 +31,14 @@ Mnemonic: DIN
 Inputs:
 
 Outputs:
-  - name: Digital Input
-    type: bool
-  - name: ErrFlag
-    type: bool
+  - { name: "Digital Input", type: "bool" }
+  - { name: "ErrFlag",       type: "bool" }
 
 Parameters:
-  - name: Pin number [0-15]
-    type: uint8
-  - name: Use variable threshold
-    type: bool
-  - name: Pull
-    type: Choice from Pull-down or Pull-up
-  - name: Active
-    type: Choice from Active or Tri-stated
+  - { name: "Pin number [0-15]",      type: "uint8"                            }
+  - { name: "Use variable threshold", type: "bool"                             }
+  - { name: "Pull",                   type: "Choice from Pull-down or Pull-up" }
+  - { name: "Active",                 type: "Choice from Active or Tri-stated" }
 
 # Description is in Markdown mark-up
 Description: >
index 6e7d0aa6af1fad9f343bad88697156645189534b..2a94bb0ffe6d568b691f08996bcea3659d6e4406 100644 (file)
@@ -33,10 +33,8 @@ Inputs:
 Outputs:
 
 Parameters:
-  - name: Reference voltage for pins 8-11 [0-4095]
-    type: uint16
-  - name: Reference voltage for pins 12-15 [0-4095]
-    type: uint16
+  - { name: "Reference voltage for pins 8-11 [0-4095]", type: "uint16" }
+  - { name: "Reference voltage for pins 12-15 [0-4095]", type: "uint16" }
 
 # Description is in Markdown mark-up
 Description: >
index e4f1dc37929ac50b0da1abbf07241d90e4c23222..434943baab50d44cabe8c90b068378a8153bf0bb 100644 (file)
@@ -31,116 +31,62 @@ Mnemonic: FRC
 Inputs:
 
 Outputs:
-  - name: ErrFlag
-    type: bool
+  - { name: "ErrFlag", type: "bool" }
 
 Parameters:
-  - name: gColdStartAttempts
-    type: uint8
-  - name: gListenNoise
-    type: uint8
-  - name: gMacroPerCycle
-    type: uint16
-  - name: gMaxWithoutClockCorrectionFatal
-    type: uint8
-  - name: gMaxWithoutClockCorrectionPassive
-    type: uint8
-  - name: gNetworkManagementVectorLength
-    type: uint8
-  - name: gNumberOfMinislots
-    type: uint16
-  - name: gNumberOfStaticSlots
-    type: uint16
-  - name: gOffsetCorrectionStart
-    type: uint16
-  - name: gPayloadLengthStatic
-    type: uint8
-  - name: gSyncNodeMax
-    type: uint8
-  - name: gdActionPointOffset
-    type: uint8
-  - name: gdCASRxLowMax
-    type: uint8
-  - name: gdDynamicSlotIdlePhase
-    type: uint8
-  - name: gdMinislot
-    type: uint8
-  - name: gdMinislotActionPointOffset
-    type: uint8
-  - name: gdNIT
-    type: uint16
-  - name: gdSampleClockPeriod
-    type: uint8
-  - name: gdStaticSlot
-    type: uint16
-  - name: gdTSSTransmitter
-    type: uint8
-  - name: gdWakeupSymbolRxIdle
-    type: uint8
-  - name: gdWakeupSymbolRxLow
-    type: uint8
-  - name: gdWakeupSymbolRxWindow
-    type: uint16
-  - name: gdWakeupSymbolTxIdle
-    type: uint8
-  - name: gdWakeupSymbolTxLow
-    type: uint8
-  - name: pAllowHaltDueToClock
-    type: bool
-  - name: pAllowPassiveToActive
-    type: uint8
-  - name: pChannels
-    type: uint8
-  - name: pClusterDriftDamping
-    type: uint8
-  - name: pDelayCompensationA
-    type: uint16
-  - name: pDelayCompensationB
-    type: uint16
-  - name: pExternOffsetCorrection
-    type: uint8
-  - name: pExternRateCorrection
-    type: uint8
-  - name: pKeySlotUsedForStartup
-    type: bool
-  - name: pKeySlotUsedForSync
-    type: bool
-  - name: pLatestTx
-    type: uint16
-  - name: pMacroInitialOffsetA
-    type: uint8
-  - name: pMacroInitialOffsetB
-    type: uint8
-  - name: pMicroInitialOffsetA
-    type: uint8
-  - name: pMicroInitialOffsetB
-    type: uint8
-  - name: pMicroPerCycle
-    type: uint32
-  - name: pRateCorrectionOut
-    type: uint16
-  - name: pOffsetCorrectionOut
-    type: uint16
-  - name: pSamplesPerMicrotick
-    type: uint8
-  - name: pSingleSlotEnabled
-    type: uint8
-  - name: pWakeupChannel
-    type: uint8
-  - name: pWakeupPattern
-    type: uint8
-  - name: pdAcceptedStartupRange
-    type: uint16
-  - name: pdListenTimeout
-    type: uint32
-  - name: pdMaxDrift
-    type: uint16
-  - name: pDecodingCorrection
-    type: uint8
-  - name: syncFramePayloadMultiplexEnabled
-    type: bool
-  - name: secureBuffers
-    type: uint8
+  - { name: "gColdStartAttempts",                type: "uint8"  }
+  - { name: "gListenNoise",                      type: "uint8"  }
+  - { name: "gMacroPerCycle",                    type: "uint16" }
+  - { name: "gMaxWithoutClockCorrectionFatal",   type: "uint8"  }
+  - { name: "gMaxWithoutClockCorrectionPassive", type: "uint8"  }
+  - { name: "gNetworkManagementVectorLength",    type: "uint8"  }
+  - { name: "gNumberOfMinislots",                type: "uint16" }
+  - { name: "gNumberOfStaticSlots",              type: "uint16" }
+  - { name: "gOffsetCorrectionStart",            type: "uint16" }
+  - { name: "gPayloadLengthStatic",              type: "uint8"  }
+  - { name: "gSyncNodeMax",                      type: "uint8"  }
+  - { name: "gdActionPointOffset",               type: "uint8"  }
+  - { name: "gdCASRxLowMax",                     type: "uint8"  }
+  - { name: "gdDynamicSlotIdlePhase",            type: "uint8"  }
+  - { name: "gdMinislot",                        type: "uint8"  }
+  - { name: "gdMinislotActionPointOffset",       type: "uint8"  }
+  - { name: "gdNIT",                             type: "uint16" }
+  - { name: "gdSampleClockPeriod",               type: "uint8"  }
+  - { name: "gdStaticSlot",                      type: "uint16" }
+  - { name: "gdTSSTransmitter",                  type: "uint8"  }
+  - { name: "gdWakeupSymbolRxIdle",              type: "uint8"  }
+  - { name: "gdWakeupSymbolRxLow",               type: "uint8"  }
+  - { name: "gdWakeupSymbolRxWindow",            type: "uint16" }
+  - { name: "gdWakeupSymbolTxIdle",              type: "uint8"  }
+  - { name: "gdWakeupSymbolTxLow",               type: "uint8"  }
+  - { name: "pAllowHaltDueToClock",              type: "bool"   }
+  - { name: "pAllowPassiveToActive",             type: "uint8"  }
+  - { name: "pChannels",                         type: "uint8"  }
+  - { name: "pClusterDriftDamping",              type: "uint8"  }
+  - { name: "pDelayCompensationA",               type: "uint16" }
+  - { name: "pDelayCompensationB",               type: "uint16" }
+  - { name: "pExternOffsetCorrection",           type: "uint8"  }
+  - { name: "pExternRateCorrection",             type: "uint8"  }
+  - { name: "pKeySlotUsedForStartup",            type: "bool"   }
+  - { name: "pKeySlotUsedForSync",               type: "bool"   }
+  - { name: "pLatestTx",                         type: "uint16" }
+  - { name: "pMacroInitialOffsetA",              type: "uint8"  }
+  - { name: "pMacroInitialOffsetB",              type: "uint8"  }
+  - { name: "pMicroInitialOffsetA",              type: "uint8"  }
+  - { name: "pMicroInitialOffsetB",              type: "uint8"  }
+  - { name: "pMicroPerCycle",                    type: "uint32" }
+  - { name: "pRateCorrectionOut",                type: "uint16" }
+  - { name: "pOffsetCorrectionOut",              type: "uint16" }
+  - { name: "pSamplesPerMicrotick",              type: "uint8"  }
+  - { name: "pSingleSlotEnabled",                type: "uint8"  }
+  - { name: "pWakeupChannel",                    type: "uint8"  }
+  - { name: "pWakeupPattern",                    type: "uint8"  }
+  - { name: "pdAcceptedStartupRange",            type: "uint16" }
+  - { name: "pdListenTimeout",                   type: "uint32" }
+  - { name: "pdMaxDrift",                        type: "uint16" }
+  - { name: "pDecodingCorrection",               type: "uint8"  }
+  - { name: "syncFramePayloadMultiplexEnabled",  type: "bool"   }
+  - { name: "secureBuffers",                     type: "uint8"  }
 
 # Description is in Markdown mark-up
 Description: >
index fae9f15290e40f94adcb4ed7f2b4c85219f87b54..3982ed8ae9cf7af4d2dbe9e4ba1fe2dec21a8e2b 100644 (file)
@@ -31,30 +31,19 @@ Mnemonic: FRC
 Inputs:
 
 Outputs:
-  - name: ErrFlag
-    type: bool
-  - name: Receive
-    type: uint8 vector
-  - name: Length
-    type: uint8
-  - name: Trigger
-    type: bool
+  - { name: "ErrFlag", type: "bool" }
+  - { name: "Receive", type: "uint8 vector" }
+  - { name: "Length", type: "uint8" }
+  - { name: "Trigger", type: "bool" }
 
 Parameters:
-  - name: channel
-    type: uint8
-  - name: cycleCounterFiltering
-    type: uint8
-  - name: maxPayload
-    type: uint8
-  - name: msgBufferInterrupt
-    type: bool
-  - name: payloadPreambleIndicatorTr
-    type: bool
-  - name: singleTransmit
-    type: bool
-  - name: slotId
-    type: uint32
+  - { name: "channel", type: "uint8" }
+  - { name: "cycleCounterFiltering", type: "uint8" }
+  - { name: "maxPayload", type: "uint8" }
+  - { name: "msgBufferInterrupt", type: "bool" }
+  - { name: "payloadPreambleIndicatorTr", type: "bool" }
+  - { name: "singleTransmit", type: "bool" }
+  - { name: "slotId", type: "uint32" }
 
 # Description is in Markdown mark-up
 Description: >
index 17d43b8eb9de3d6a239fccfe0d511bcd6fd5e186..b45406ec74eec3214c466bfe1ba963e8c064979f 100644 (file)
@@ -29,28 +29,19 @@ Header: rpp/fr.h
 Mnemonic: FRC
 
 Inputs:
-  - name: Send
-    type: uint8 vector
+  - { name: "Send", type: "uint8 vector" }
 
 Outputs:
-  - name: ErrFlag
-    type: bool
+  - { name: "ErrFlag", type: "bool" }
 
 Parameters:
-  - name: channel
-    type: uint8
-  - name: cycleCounterFiltering
-    type: uint8
-  - name: maxPayload
-    type: uint8
-  - name: msgBufferInterrupt
-    type: bool
-  - name: payloadPreambleIndicatorTr
-    type: bool
-  - name: singleTransmit
-    type: bool
-  - name: slotId
-    type: uint32
+  - { name: "channel", type: "uint8" }
+  - { name: "cycleCounterFiltering", type: "uint8" }
+  - { name: "maxPayload", type: "uint8" }
+  - { name: "msgBufferInterrupt", type: "bool" }
+  - { name: "payloadPreambleIndicatorTr", type: "bool" }
+  - { name: "singleTransmit", type: "bool" }
+  - { name: "slotId", type: "uint32" }
 
 # Description is in Markdown mark-up
 Description: >
index 511fe9a884d57d3282a36ee1151a4db84ba9a3c6..4239c64614c935290d878357d5b7bf48b4b0f988 100644 (file)
@@ -29,14 +29,11 @@ Header: rpp/hbr.h
 Mnemonic: HBR
 
 Inputs:
-  - name: Enable
-    type: bool
-  - name: Control
-    type: double
+  - { name: "Enable",  type: "bool"   }
+  - { name: "Control", type: "double" }
 
 Outputs:
-  - name: ErrFlag
-    type: bool
+  - { name: "ErrFlag", type: "bool" }
 
 Parameters:
 
index 7c36809e82ffb12a1ce720d360faecf4e8fe0448..437107ce7406f2c5a7c46b1dbde32b93ab3a2729 100644 (file)
@@ -31,14 +31,11 @@ Mnemonic: IRC
 Inputs:
 
 Outputs:
-  - name: IRC value
-    type: int32
-  - name: ErrFlag
-    type: bool
+  - { name: "IRC value", type: "int32" }
+  - { name: "ErrFlag", type: "bool" }
 
 Parameters:
-  - name: IRC number [1-2]
-    type: uint8
+  - { name: "IRC number [1-2]", type: "uint8" }
 
 # Description is in Markdown mark-up
 Description: >
index 0586b6e44b3499adca41e9fe337ac15690a31989..db77a20970bb88952a9381e8e035b91282fd4f9f 100644 (file)
@@ -29,16 +29,13 @@ Header: rpp/lout.h
 Mnemonic: LOUT
 
 Inputs:
-  - name: Digital Output
-    type: bool
+  - { name: "Digital Output",   type: "bool"  }
 
 Outputs:
-  - name: ErrFlag
-    type: bool
+  - { name: "ErrFlag",          type: "bool"  }
 
 Parameters:
-  - name: Pin number [1-8]
-    type: uint8
+  - { name: "Pin number [1-8]", type: "uint8" }
 
 # Description is in Markdown mark-up
 Description: >
index 067f2449f89abbf48e4afe766d66d9fd0dde777c..0d6a72c33d103fc9d02eb60d3c8df3079d528f68 100644 (file)
@@ -29,16 +29,13 @@ Header: rpp/mout.h
 Mnemonic: MOUT
 
 Inputs:
-  - name: Power Output
-    type: bool
+  - { name: "Power Output", type: "bool" }
 
 Outputs:
-  - name: ErrFlag
-    type: bool
+  - { name: "ErrFlag", type: "bool" }
 
 Parameters:
-  - name: Pin number [1-6]
-    type: uint8
+  - { name: "Pin number [1-6]", type: "uint8" }
 
 # Description is in Markdown mark-up
 Description: >
index 7bd954133cfc2b34e1ab4bb7e7f03bcc7e09e162..199e02e169163de97fbebe3cc203c312f1f741c2 100644 (file)
@@ -33,8 +33,7 @@ Inputs:
 Outputs:
 
 Parameters:
-  - name: Baud rate
-    type: uint32
+  - { name: "Baud rate", type: "uint32" }
 
 # Description is in Markdown mark-up
 Description: >
index 52a3c796fb882fed996fa653b72f8d4d8e325e22..e01d46bd90fcd988e118fe2761b121d9d946d1c0 100644 (file)
@@ -29,16 +29,13 @@ Header: rpp/sci.h
 Mnemonic: SCIP
 
 Inputs:
-  - name: Send
-    type: dynamically
+  - { name: "Send", type: "dynamically" }
 
 Outputs:
-  - name: ErrFlag
-    type: bool
+  - { name: "ErrFlag", type: "bool" }
 
 Parameters:
-  - name: PrintFormat [SETTING]
-    type: string
+  - { name: "PrintFormat [SETTING]", type: "string" }
 
 # Description is in Markdown mark-up
 Description: >
index e12d6c64265b5d08249390af8cd31bf218f7cdcc..01e862d1f0309b88f9532af5b2ae49f4baa37221 100644 (file)
@@ -31,10 +31,8 @@ Mnemonic: SCIR
 Inputs:
 
 Outputs:
-  - name: Data
-    type: uint8
-  - name: ErrFlag
-    type: bool
+  - { name: "Data", type: "uint8" }
+  - { name: "ErrFlag", type: "bool" }
 
 Parameters:
 
index 4f5a3eae2e0edafc9db2679e6fb7a0e176dffb1a..f433e6d35fc0585e3b8998d7ff979e23057339e0 100644 (file)
@@ -29,12 +29,10 @@ Header: rpp/sci.h
 Mnemonic: SCIS
 
 Inputs:
-  - name: Send
-    type: uint8
+  - { name: "Send", type: "uint8" }
 
 Outputs:
-  - name: ErrFlag
-    type: bool
+  - { name: "ErrFlag", type: "bool" }
 
 Parameters:
 
index 5266cfde2ec3335a51a5c7b878c0b2066448ef6c..4e44a4ccf0e2225bba4c154a6a94b5b49cff00c2 100644 (file)
@@ -29,18 +29,14 @@ Header: rpp/sdc.h
 Mnemonic: SDRW
 
 Inputs:
-  - name: Data
-    type: double
+  - { name: "Data", type: "double" }
 
 Outputs:
-  - name: ErrFlag
-    type: bool
+  - { name: "ErrFlag", type: "bool" }
 
 Parameters:
-  - name: Block ID
-    type: uint8
-  - name: PrintFormat [SETTING]
-    type: string
+  - { name: "Block ID",              type: "uint8"  }
+  - { name: "PrintFormat [SETTING]", type: "string" }
 
 # Description is in Markdown mark-up
 Description: >