# IvyModuleDescriptorSpec

interface IvyModuleDescriptorSpec(source)

The descriptor of any Ivy publication.

Corresponds to the XML version of the Ivy Module Descriptor.

The withXml method can be used to modify the descriptor after it has been generated according to the publication data. However, the preferred way to customize the project information to be published is to use the dedicated configuration methods exposed by this class, e.g. description.

#### Since

2.1

## Functions

author
Link copied to clipboard
abstract fun author(action: Action<in IvyModuleDescriptorAuthor>)
Creates, configures and adds an author to this publication.
description
Link copied to clipboard
abstract fun description(action: Action<in IvyModuleDescriptorDescription>)
Configures the description for this publication.
extraInfo
Link copied to clipboard
abstract fun extraInfo(namespace: String, elementName: String, value: String)
Adds a new extra info element to the publication
getBranch
Link copied to clipboard
@Nullable
abstract fun getBranch(): @Nullable String
Returns the branch for this publication
getExtraInfo
Link copied to clipboard
abstract fun getExtraInfo(): IvyExtraInfoSpec
Returns the extra info element spec for this publication
getStatus
Link copied to clipboard
@Nullable
abstract fun getStatus(): @Nullable String
Returns the status for this publication.
license
Link copied to clipboard
abstract fun license(action: Action<in IvyModuleDescriptorLicense>)
Creates, configures and adds a license to this publication.
setBranch
Link copied to clipboard
abstract fun setBranch(@Nullable branch: @Nullable String)
Sets the branch for this publication
setStatus
Link copied to clipboard
abstract fun setStatus(@Nullable status: @Nullable String)
Sets the status for this publication.
withXml
Link copied to clipboard
abstract fun withXml(action: Action<in XmlProvider>)
Allow configuration of the descriptor, after it has been generated according to the input data.