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
directory No String Only supported for include paths where path points to a location outside the project root. If the project is copied, the all listed files are moved to this directory relative to the project root and the project file is rewritten to reflect the new layout. If not set, a default of . is assumed. If the project is not copied, the value of directory may be used to show the files at a virtual location in IDEs that support this.

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
1
2
3
4
5
6
7
8
include:
  - path: inc
    file_list:
      - path: app.h
  - path: ../util
    file_list:
      - path: util.h
    directory: util
Back to top