Skip to content

include

Required: No
Type: List of include files
Condition: Yes

List of paths and the files contained within that shall be referenced as include paths in the exported IDE project.

Key Required Type Description
path Yes Include path
file_list No List of include files Exhaustive list of header files within the include path
condition No List of features The include path is added if all the given features are present
unless No List of features The include path is added unless any of the given features are present

All header files on the include path are listed under the file_list key so that the correct content is copied to the user project when generating with the copy flag set. It also makes it possible to separate public from internal header files when packaging a SDK for release.

Each header file is represented by the following data:

Key Required Type Description
path Yes Include path Path to the header file
condition No List of features The header file is added if all the given features are present
unless No List of features The header file is added unless any of the given features are present
folder (deprecated) No String Override the visual directory structure in IDE tree views. When set, the header file is shown under this path rather than the real path on disk. Does not change the location of the file on disk.
1
2
3
4
include:
  - path: inc
    file_list:
      - path: app.h
Back to top