blob: c3ee4f0bf860d897d08bdcfb6e1a2e789a22affc (
plain) (
blame)
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: Very long function brief description.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
default:
attributes: null
body: |
(void) ${.:/params[1]/name};
(void) ${.:/params[2]/name};
(void) ${.:/params[3]/name};
return ${.:/params[0]/name} + 1;
params:
- int ${.:/params[0]/name}
- const ${forward-decl:/name} *${.:/params[1]/name}
- ${forward-decl:/name} *( *${.:/params[2]/name} )( void )
- ${forward-decl:/name} *${.:/params[3]/name}
return: int
variants: []
description: |
VeryLongFunction description.
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
uid: h
- role: interface-ingroup
uid: gb
name: VeryLongFunction
notes: |
VeryLongFunction notes.
params:
- description: |
is very long parameter 0 with some super important and extra very long
description which makes a lot of sense.
dir: null
name: VeryLongParam0
- description: is very long parameter 1.
dir: in
name: VeryLongParam1
- description: is very long parameter 2.
dir: out
name: VeryLongParam2
- description: is very long parameter 3.
dir: inout
name: VeryLongParam3
return:
return: Sometimes some value. See ${func:/name}.
return-values:
- description: is returned, in case A.
value: 1
- description: is returned, in case B.
value: 2
- description: is returned, in case C.
value: ${enum:/name}
type: interface
|
