Package software.amazon.smithy.docgen.sections.sphinx

Record Class ConfSection

java.lang.Object
java.lang.Record
software.amazon.smithy.docgen.sections.sphinx.ConfSection
Record Components:
context - The context used to generate documentation.
extensions - Extensions needed to generate documentation.
All Implemented Interfaces:
CodeSection
public record ConfSection(DocGenerationContext context, Set<String> extensions) extends Record implements CodeSection
Generates the conf.py file for sphinx.
See Also:

  • Constructor Details

    • ConfSection

      public ConfSection(DocGenerationContext context, Set<String> extensions)
      Creates an instance of a ConfSection record class.
      Parameters:
      context - the value for the context record component
      extensions - the value for the extensions record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • context

      public DocGenerationContext context()
      Returns the value of the context record component.
      Returns:
      the value of the context record component

    • extensions

      public Set<String> extensions()
      Returns the value of the extensions record component.
      Returns:
      the value of the extensions record component