Package org.gradle.api.attributes

Interface DocsType

  • All Superinterfaces:
    Named
    public interface DocsType
extends Named
    Attributes to qualify the type of documentation.

    This attribute is usually found on variants that have the Category attribute valued at documentation.

    Since:
    5.6

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.gradle.api.Named

        Named.Namer

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Attribute<DocsType> DOCS_TYPE_ATTRIBUTE  
      static java.lang.String DOXYGEN
      The typical documentation for native APIs
      static java.lang.String JAVADOC
      The typical documentation for Java APIs
      static java.lang.String SAMPLES
      Samples illustrating how to use the software module
      static java.lang.String SOURCES
      The source files of the module
      static java.lang.String USER_MANUAL
      A user manual

    • Method Summary

    • Field Detail

      • JAVADOC

        static final java.lang.String JAVADOC
        The typical documentation for Java APIs
        See Also:
        Constant Field Values

      • SOURCES

        static final java.lang.String SOURCES
        The source files of the module
        See Also:
        Constant Field Values

      • SAMPLES

        static final java.lang.String SAMPLES
        Samples illustrating how to use the software module
        See Also:
        Constant Field Values

      • DOXYGEN

        static final java.lang.String DOXYGEN
        The typical documentation for native APIs
        See Also:
        Constant Field Values