api / org.gradle.language.cpp / CppLibrary

CppLibrary

@Incubating interface CppLibrary : ProductionCppComponent

Configuration for a C++ library, defining the source files and header directories that make up the library plus other settings.

An instance of this type is added as a project extension by the C++ library plugin.

Since
4.2

Functions

getApiDependencies

abstract fun getApiDependencies(): Configuration

Returns the API dependencies of this library.

getDependencies

abstract fun getDependencies(): LibraryDependencies

Returns the dependencies of this library.

getLinkage

abstract fun getLinkage(): SetProperty<Linkage>

Returns the list of linkage of this library.

getPublicHeaderDirs

abstract fun getPublicHeaderDirs(): FileCollection

Returns the public header file directories of this component, as defined in #getPublicHeaders().

getPublicHeaderFiles

abstract fun getPublicHeaderFiles(): FileTree

Returns public header files of this component.

getPublicHeaders

abstract fun getPublicHeaders(): ConfigurableFileCollection

Defines the public header file directories of this library.

When this collection is empty, the directory src/main/public is used by default.

publicHeaders

abstract fun publicHeaders(action: Action<in ConfigurableFileCollection>): Unit

Configures the public header directories for this component.

Inherited Functions

getDevelopmentBinary

abstract fun getDevelopmentBinary(): Provider<out CppBinary>

{@inheritDoc}