blob: c60a9302938d7b19fe5f92f3c0cbfa920fe6763d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: Function brief description.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
default:
attributes: null
body: null
params:
- int ${.:/params[0]/name}
- const int *${.:/params[1]/name}
- int *${.:/params[2]/name}
- int *${.:/params[3]/name}
- int *${.:/params[4]/name}
return: void
variants: []
description: |
Function description. References to ${term:/plural}, ${func2:/name},
${td:/name}, ${enum:/name}, ${define:/name}, ${macro:/name}, ${var:/name},
${enumerator-0:/name}, ${s:/name}, ${option:/name}, ${option:/type},
${ga:/name}, and ${gf:/name}. Second parameter is ${.:/params[1]/name}.
Mention ${unspecified-struct:/name}.
.. code-block:
these two lines
are not wrapped
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
uid: h
- role: interface-ingroup
uid: ga
- role: constraint
uid: constraint-a
name: Function
notes: null
params:
- description: is parameter 0.
dir: null
name: Param0
- description: is parameter 1.
dir: in
name: Param1
- description: is parameter 2.
dir: out
name: Param2
- description: is parameter 3.
dir: inout
name: Param3
- description: null
dir: null
name: Param4
return: null
type: interface
|