source: rtems-central/rtemsqual/tests/spec-interface/func2.yml @ ddbc8f7

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: []
interface-brief: Very long function brief description.
interface-description: null
interface-definition:
  default:
    body: |
      (void) ${.:/interface-params[1]/name};
      (void) ${.:/interface-params[2]/name};
      (void) ${.:/interface-params[3]/name};
      return ${.:/interface-params[0]/name} + 1;
    params:
    - int ${.:/interface-params[0]/name}
    - const ${forward-decl:/interface-name} *${.:/interface-params[1]/name}
    - ${forward-decl:/interface-name} *${.:/interface-params[2]/name}
    - ${forward-decl:/interface-name} *${.:/interface-params[3]/name}
    return: int
  variants: []
interface-name: VeryLongFunction
interface-params:
- name: VeryLongParam0
  dir: null
  description: |
    is very long parameter 0 with some super important and extra very long
    description which makes a lot of sense.
- name: VeryLongParam1
  dir: in
  description: is very long parameter 1.
- name: VeryLongParam2
  dir: out
  description: is very long parameter 2.
- name: VeryLongParam3
  dir: inout
  description: is very long parameter 3.
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: function
links:
- role: include
  uid: h
- role: ingroup
  uid: gb
type: interface