Skip to main content

publicIncludeFolders property

note

Work in progress.

Purpose​

Specify the folders containing public header files used during the build and propagated up to the artefact.

Syntax​

{
  "cdlOptions | cdlComponents": [
    {
      "name": "...",
      ...
      "publicIncludeFolders": [ "<relative folder path>",... ],
      ...
    }
  ]
}

The value of the publicIncludeFolders property is an array of strings that specify folder paths relative to the location of the current xCDL file. These folders contain header files used during the build of the current component.

Default value​

If missing, the current object will not contribute any header folders to the build.

Description​

Most packages export one or more folders with header files defining their public interface.

If the package follows the folders layout conventions then the exported header files will normally be found in the package's include sub-folder.

See also​

eCos reference​