class IndexScript extends Page
- Source
- IndexScript.scala
- Alphabetic
- By Inheritance
- IndexScript
- Page
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from IndexScript to any2stringadd[IndexScript] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (IndexScript, B)
- Implicit
- This member is added by an implicit conversion from IndexScript to ArrowAssoc[IndexScript] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
absoluteLinkTo(path: List[String]): String
- Definition Classes
- Page
- def allPackages: List[Package]
- def allPackagesWithTemplates: Map[Package, List[DocTemplateEntity]]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
createFileOutputStream(site: HtmlFactory, suffix: String = ""): FileOutputStream
- Definition Classes
- Page
-
def
ensuring(cond: (IndexScript) ⇒ Boolean, msg: ⇒ Any): IndexScript
- Implicit
- This member is added by an implicit conversion from IndexScript to Ensuring[IndexScript] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (IndexScript) ⇒ Boolean): IndexScript
- Implicit
- This member is added by an implicit conversion from IndexScript to Ensuring[IndexScript] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): IndexScript
- Implicit
- This member is added by an implicit conversion from IndexScript to Ensuring[IndexScript] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): IndexScript
- Implicit
- This member is added by an implicit conversion from IndexScript to Ensuring[IndexScript] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hasCompanion(mbr: TemplateEntity): Boolean
- Definition Classes
- Page
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
kindToString(mbr: MemberEntity): String
- Definition Classes
- Page
- def memberToUrl(mbr: MemberEntity): String
-
def
membersToJSON(entities: Vector[MemberEntity], parent: DocTemplateEntity): JSONArray
Returns the json representation of the supplied members
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val packages: JSONObject
-
def
path: collection.immutable.List[String]
The path of this page, relative to the API site.
The path of this page, relative to the API site.
path.tailis a list of folder names leading to this page (from closest package to one-above-root package),path.headis the file name of this page. Note thatpathhas a length of at least one.- Definition Classes
- IndexScript → Page
-
def
relativeLinkTo(destPath: List[String]): String
A relative link from a page's path to some destination path.
A relative link from a page's path to some destination path.
- destPath
The path that the link will point to.
- Definition Classes
- Page
-
def
relativeLinkTo(destClass: TemplateEntity): String
A relative link from this page to some destination class entity.
A relative link from this page to some destination class entity.
- destClass
The class or object entity that the link will point to.
- Definition Classes
- Page
-
def
shortDesc(mbr: MemberEntity): String
Gets the short description i.e.
Gets the short description i.e. the first sentence of the docstring
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
templateToPath(tpl: TemplateEntity): List[String]
- Definition Classes
- Page
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
writeFile(site: HtmlFactory, suffix: String = "")(fn: (Writer) ⇒ Unit): Unit
- Definition Classes
- Page
-
def
writeFor(site: HtmlFactory): Unit
Writes this page as a file.
Writes this page as a file. The file's location is relative to the generator's site root, and the encoding is also defined by the generator.
- site
The generator that is writing this page.
- Definition Classes
- IndexScript → Page
-
def
→[B](y: B): (IndexScript, B)
- Implicit
- This member is added by an implicit conversion from IndexScript to ArrowAssoc[IndexScript] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Deprecated Value Members
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from IndexScript to StringFormat[IndexScript] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
The Scala compiler and reflection APIs.