blob: 1d49c6592540167abad71f3f970ef6b1a65e5ed5 (
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
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
interface-brief: Very long macro brief description.
interface-definition:
default: |
do {
(void) ${.:/interface-params[1]/name};
(void) ${.:/interface-params[2]/name};
(void) ${.:/interface-params[3]/name};
} while ( 0 );
${.:/interface-params[0]/name} + 1;
variants: []
interface-description: null
interface-name: VERY_LONG_MACRO
interface-notes: null
interface-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
interface-return:
return: Sometimes some value.
return-values:
- description: is returned, in case A.
value: 1
- description: is returned, in case B.
value: 2
interface-type: macro
links:
- role: interface-placement
uid: h
- role: interface-ingroup
uid: gb
type: interface
|
