case class ConfigEntry(value: String, comment: DocumentationComment) extends ConfigNode with Product with Serializable
Stores a value inside the structure of the configNode.
- value
is the value stored in the entry.
- comment
are all the comments associated with the value.
- Source
- ConfigEntry.scala
- Alphabetic
- By Inheritance
- ConfigEntry
- Serializable
- Product
- Equals
- ConfigNode
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ConfigEntry(value: String, comment: DocumentationComment)
- value
is the value stored in the entry.
- comment
are all the comments associated with the value.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- def collapse(): Unit
Collapse is not needed in config Entry, due to it not having any sub-objects.
Collapse is not needed in config Entry, due to it not having any sub-objects.
- Definition Classes
- ConfigEntry → ConfigNode
- var comment: DocumentationComment
- Definition Classes
- ConfigEntry → ConfigNode
- def entriesToHTML(exporter: HTMLExporter, pageHTML: StringBuilder)(implicit project: SomeProject): Unit
Produces the HTML for the individual entries.
Produces the HTML for the individual entries.
- pageHTML
accepts a StringBuilder. The method adds the HTML String to this StringBuilder.
- Attributes
- protected
- Definition Classes
- ConfigEntry → ConfigNode
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def expand(): Unit
Expand is not needed in config Entry, due to it not having any sub-objects.
Expand is not needed in config Entry, due to it not having any sub-objects.
- Definition Classes
- ConfigEntry → ConfigNode
- def getBrief(exporter: HTMLExporter)(implicit project: SomeProject): String
Returns an HMTL-escaped text for the brief description.
Returns an HMTL-escaped text for the brief description.
- Attributes
- protected
- Definition Classes
- ConfigNode
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def getHeadlineText(label: String): String
Returns a text for the HTML headline entry.
Returns a text for the HTML headline entry.
- Attributes
- protected
- Definition Classes
- ConfigNode
- def isEmpty: Boolean
Checks if the value object is empty.
Checks if the value object is empty.
- returns
true if both the value and the comment are empty.
- Definition Classes
- ConfigEntry → ConfigNode
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def replaceClasses(se: SubclassExtractor): Unit
Method for replacing a potential subclass type in the comment of the entry.
Method for replacing a potential subclass type in the comment of the entry.
- se
Accepts an initialized SubclassExtractor containing the ClassHierarchy required for a successful replacement.
- Definition Classes
- ConfigEntry → ConfigNode
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toHTML(exporter: HTMLExporter, label: String, pageHTML: StringBuilder)(implicit project: SomeProject): Unit
Method for handling the export of the configuration structure into an HTML file.
Method for handling the export of the configuration structure into an HTML file.
- label
required if the Object is part of another object (Writes the key of the K,V Map there instead). Overrides the label property of the Comment object. Supply an empty string if not needed.
- pageHTML
accepts a StringBuilder. The method adds the HTML String to this StringBuilder.
- Definition Classes
- ConfigNode
- val value: String
- def valueToHTML(exporter: HTMLExporter, pageHTML: StringBuilder)(implicit project: SomeProject): Unit
- Definition Classes
- ConfigEntry → ConfigNode
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
- Deprecated