mirror of
https://github.com/apple/pkl.git
synced 2026-03-23 01:29:20 +01:00
Initial commit
This commit is contained in:
22
pkl-doc/src/test/files/DocGeneratorTest/input/com.externalpackage/doc-package-info.pkl
vendored
Normal file
22
pkl-doc/src/test/files/DocGeneratorTest/input/com.externalpackage/doc-package-info.pkl
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
amends "pkl:DocPackageInfo"
|
||||
|
||||
name = "com.externalpackage"
|
||||
version = "1.2.3"
|
||||
importUri = "https://pkl.io/"
|
||||
authors {
|
||||
"publisher-externalpackage@group.apple.com"
|
||||
}
|
||||
sourceCode = "https://example.com/externalpackage/"
|
||||
sourceCodeUrlScheme = "https://example.com/blob/\(version)%{path}#L%{line}-L%{endLine}"
|
||||
issueTracker = "https://example.com/externalpackage/issues"
|
||||
|
||||
dependencies {
|
||||
new {
|
||||
name = "pkl"
|
||||
// use fixed version to avoid churn in expected test outputs
|
||||
version = "0.24.0"
|
||||
sourceCode = "https://github.com/apple/\(name)/blob/dev/stdlib/"
|
||||
sourceCodeUrlScheme = "https://github.com/apple/\(name)/blob/\(version)/stdlib%{path}#L%{line}-L%{endLine}"
|
||||
documentation = "https://pkl-lang.org/stdlib/\(name)/\(version)/"
|
||||
}
|
||||
}
|
||||
3
pkl-doc/src/test/files/DocGeneratorTest/input/com.externalpackage/external1.pkl
vendored
Normal file
3
pkl-doc/src/test/files/DocGeneratorTest/input/com.externalpackage/external1.pkl
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
module com.externalpackage.external1
|
||||
|
||||
class MyClass
|
||||
3
pkl-doc/src/test/files/DocGeneratorTest/input/com.externalpackage/external2.pkl
vendored
Normal file
3
pkl-doc/src/test/files/DocGeneratorTest/input/com.externalpackage/external2.pkl
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
module com.externalpackage.external2
|
||||
|
||||
class MyClass
|
||||
7
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/baseModule.pkl
vendored
Normal file
7
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/baseModule.pkl
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
open module com.package1.baseModule
|
||||
|
||||
baseProperty = 42
|
||||
|
||||
function baseMethod() = 42
|
||||
|
||||
class BaseClass {}
|
||||
30
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classAnnotations.pkl
vendored
Normal file
30
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classAnnotations.pkl
vendored
Normal file
@@ -0,0 +1,30 @@
|
||||
open module com.package1.classAnnotations
|
||||
|
||||
/// This [AnnotatedClss] thought to have a correctly spelled name.
|
||||
@Deprecated {
|
||||
message = "Spelling mistake."
|
||||
replaceWith = "AnnotatedClass"
|
||||
}
|
||||
@AlsoKnownAs {
|
||||
names { "OtherName" }
|
||||
}
|
||||
class AnnotatedClss
|
||||
|
||||
/// This [AnnotatedClssWithExpandableComment] thought to have a correctly spelled name.
|
||||
///
|
||||
/// Unfortunately, it did not, as we explain in this expandable comment.
|
||||
@Deprecated {
|
||||
message = "Spelling mistake."
|
||||
replaceWith = "AnnotatedClass"
|
||||
}
|
||||
@AlsoKnownAs {
|
||||
names { "OtherName" }
|
||||
}
|
||||
class AnnotatedClssWithExpandableComment
|
||||
|
||||
// This [AnnotatedClass] indeed has a properly spelled name, but no doc comment.
|
||||
@AlsoKnownAs {
|
||||
names { "OtherName" }
|
||||
}
|
||||
@Deprecated // omit optional arguments
|
||||
class AnnotatedClass
|
||||
145
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classComments.pkl
vendored
Normal file
145
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classComments.pkl
vendored
Normal file
@@ -0,0 +1,145 @@
|
||||
/// The greatest breakthrough since ever.
|
||||
///
|
||||
/// ### Installation
|
||||
///
|
||||
/// Just follow these simple steps:
|
||||
///
|
||||
/// 1. Install it
|
||||
/// 1. I promise it's easy.
|
||||
/// 2. You'll figure it out.
|
||||
/// 1. Install it
|
||||
/// ```
|
||||
/// name = "Pigeon"
|
||||
/// age = 42
|
||||
/// ```
|
||||
/// 1. Install it
|
||||
///
|
||||
/// Let me **emphasize** how *simple* this is.
|
||||
///
|
||||
/// 😀😀😀 emoji day 😎😎😎 don't get 😡😡😡
|
||||
///
|
||||
/// ### Code
|
||||
///
|
||||
/// The code is beautiful:
|
||||
///
|
||||
/// ```
|
||||
/// /// example module
|
||||
/// module foo.bar
|
||||
///
|
||||
/// person {
|
||||
/// name = "Pigeon"
|
||||
/// age = 42
|
||||
/// }
|
||||
///
|
||||
/// function sing() = "tra-la-la"
|
||||
///
|
||||
/// class Person {
|
||||
/// name: String
|
||||
/// age: Int
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// ### Random Tips
|
||||
///
|
||||
/// - don't give up
|
||||
/// - just don't
|
||||
/// - don't give up
|
||||
///
|
||||
/// # Level 1
|
||||
/// ## Level 2
|
||||
/// ### Level 3
|
||||
/// #### Level 4
|
||||
/// ##### Level 5
|
||||
/// ###### Level 6
|
||||
///
|
||||
/// | Command | Description |
|
||||
/// | --- | --- |
|
||||
/// | `git status` | List all *new or modified* files |
|
||||
/// | `git diff` | Show file differences that **haven't been** staged |
|
||||
open module com.package1.classComments
|
||||
|
||||
// Class with single-line code comment.
|
||||
class Comments1
|
||||
|
||||
/*
|
||||
Class with
|
||||
multi-line
|
||||
code comment.
|
||||
*/
|
||||
class Comments2
|
||||
|
||||
/// Class with single-line doc comment.
|
||||
class Comments3
|
||||
|
||||
/// Class with multi-line and multi-paragraph doc comment (paragraph1, line1).
|
||||
/// Class with multi-line and multi-paragraph doc comment (paragraph1, line2).
|
||||
///
|
||||
/// Class with multi-line and multi-paragraph doc comment (paragraph2, line1).
|
||||
/// Class with multi-line and multi-paragraph doc comment (paragraph2, line2).
|
||||
class Comments4
|
||||
|
||||
/// Class with [single-line](https://apple.com) *Markdown* doc comment.
|
||||
class Comments5
|
||||
|
||||
/// Class with
|
||||
/// [multi-line](https://apple.com)
|
||||
/// *Markdown* doc comment.
|
||||
class Comments6
|
||||
|
||||
/// 😀😀😀 Class with 😎😎😎 Unicode doc comment. 😡😡😡
|
||||
class Comments7
|
||||
|
||||
/// The greatest breakthrough since ever.
|
||||
///
|
||||
/// ## Installation
|
||||
///
|
||||
/// Just follow these simple steps:
|
||||
///
|
||||
/// 1. Install it
|
||||
/// 1. I promise it's easy.
|
||||
/// 2. You'll figure it out.
|
||||
/// 1. Install it
|
||||
/// ```
|
||||
/// name = "Pigeon"
|
||||
/// age = 42
|
||||
/// ```
|
||||
/// 1. Install it
|
||||
///
|
||||
/// Let me **emphasize** how *simple* this is.
|
||||
///
|
||||
/// 😀😀😀 emoji day 😎😎😎 don't get 😡😡😡
|
||||
///
|
||||
/// ## Code
|
||||
///
|
||||
/// The code is beautiful:
|
||||
///
|
||||
/// ```
|
||||
/// /// example module
|
||||
/// module foo.bar
|
||||
///
|
||||
/// person {
|
||||
/// name = "Pigeon"
|
||||
/// age = 42
|
||||
/// }
|
||||
///
|
||||
/// function sing() = "tra-la-la"
|
||||
///
|
||||
/// class Person {
|
||||
/// name: String
|
||||
/// age: Int
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// ## Random Tips
|
||||
///
|
||||
/// - don't give up
|
||||
/// - just don't
|
||||
/// - don't give up
|
||||
///
|
||||
/// # Level 1
|
||||
/// ## Level 2
|
||||
/// ### Level 3
|
||||
/// #### Level 4
|
||||
/// ##### Level 5
|
||||
/// ###### Level 6
|
||||
class Comments8
|
||||
29
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classInheritance.pkl
vendored
Normal file
29
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classInheritance.pkl
vendored
Normal file
@@ -0,0 +1,29 @@
|
||||
/// Class inheritance involving abstract, open, and final classes.
|
||||
module com.package1.classInheritance
|
||||
|
||||
abstract class MyClass1 {
|
||||
/// Inherited property comment.
|
||||
abstract property1: Boolean
|
||||
|
||||
/// function method1 in class MyClass1.
|
||||
abstract function method1(arg: String): Boolean
|
||||
}
|
||||
|
||||
open class MyClass2 extends MyClass1 {
|
||||
property1: Boolean = false
|
||||
property2: String = ""
|
||||
|
||||
/// function method1 in class MyClass2.
|
||||
function method1(arg: String): Boolean = Undefined()
|
||||
function method2(arg: String): Boolean = Undefined()
|
||||
}
|
||||
|
||||
abstract class MyClass3 extends MyClass2 {
|
||||
property1: Boolean = true
|
||||
function method1(arg: String): Boolean = Undefined()
|
||||
}
|
||||
|
||||
class MyClass4 extends MyClass2 {
|
||||
property4: String = ""
|
||||
function method3(arg: String): Boolean = Undefined()
|
||||
}
|
||||
33
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classMethodComments.pkl
vendored
Normal file
33
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classMethodComments.pkl
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
/// Class methods with different kinds of comments.
|
||||
module com.package1.classMethodComments
|
||||
|
||||
class Comments {
|
||||
// Method with single-line code comment.
|
||||
function method1(): Float = Undefined()
|
||||
|
||||
/*
|
||||
Method with
|
||||
multi-line
|
||||
code comment.
|
||||
*/
|
||||
function method2(): Float = Undefined()
|
||||
|
||||
/// Method with single-line doc comment.
|
||||
function method3(): Float = Undefined()
|
||||
|
||||
/// Method with
|
||||
/// multi-line
|
||||
/// doc comment.
|
||||
function method4(): Float = Undefined()
|
||||
|
||||
/// Method with [single-line](https://apple.com) *Markdown* doc comment.
|
||||
function method5(): Float = Undefined()
|
||||
|
||||
/// Method with
|
||||
/// [multi-line](https://apple.com)
|
||||
/// *Markdown* doc comment.
|
||||
function method6(): Float = Undefined()
|
||||
|
||||
/// 😀😀😀 Method with 😎😎😎 Unicode doc comment. 😡😡😡
|
||||
function method7(): Float = Undefined()
|
||||
}
|
||||
15
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classMethodModifiers.pkl
vendored
Normal file
15
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classMethodModifiers.pkl
vendored
Normal file
@@ -0,0 +1,15 @@
|
||||
/// Class methods with different modifiers.
|
||||
module com.package1.classMethodModifiers
|
||||
|
||||
abstract class Modifiers {
|
||||
/// Method with `abstract` modifier.
|
||||
abstract function method1(arg: String): Boolean
|
||||
|
||||
/*
|
||||
/// Method with `external` modifier.
|
||||
external function method2(arg: String): Boolean
|
||||
|
||||
/// Method with multiple modifiers.
|
||||
abstract external function method3(arg: String): Boolean
|
||||
*/
|
||||
}
|
||||
43
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classMethodTypeAnnotations.pkl
vendored
Normal file
43
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classMethodTypeAnnotations.pkl
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
/// Class methods with different kinds of type annotations.
|
||||
module com.package1.classMethodTypeAnnotations
|
||||
|
||||
class TypeAnnotations {
|
||||
/// Zero-arg method without declared types.
|
||||
function method1() = Undefined()
|
||||
|
||||
/// One-arg method without declared types.
|
||||
function method2(arg1) = Undefined()
|
||||
|
||||
/// Two-arg method without declared types.
|
||||
function method3(arg1, arg2) = Undefined()
|
||||
|
||||
/// Zero-arg method with simple types.
|
||||
function method4(): String = Undefined()
|
||||
|
||||
/// One-arg method with simple types.
|
||||
function method5(arg1: Boolean): Int = Undefined()
|
||||
|
||||
/// Two-arg method with simple types.
|
||||
function method6(arg1: Int, arg2: Float): Duration = Undefined()
|
||||
|
||||
/// Two-arg method with list types.
|
||||
function method7(arg1: List<Int>, arg2: List<Float>): List<Duration> = Undefined()
|
||||
|
||||
/// Two-arg method with set types.
|
||||
function method8(arg1: Set<Int>, arg2: Set<Float>): Set<Duration> = Undefined()
|
||||
|
||||
/// Two-arg method with map types.
|
||||
function method9(arg1: Map<Int, Int>, arg2: Map<Float, Float>): Map<Duration, Duration> = Undefined()
|
||||
|
||||
/// Two-arg method with optional types.
|
||||
function method10(arg1: Int?, arg2: Float?): Duration? = Undefined()
|
||||
|
||||
/// Two-arg method with function types.
|
||||
function method11(arg1: () -> Int, arg2: (Int) -> Float): (Int, Float) -> Duration = Undefined()
|
||||
|
||||
/// Two-arg method with partially declared types.
|
||||
function method12(arg1: String, arg2): Boolean = Undefined()
|
||||
|
||||
/// One-arg method with complex types.
|
||||
function method13(arg1: Map<List<String?>?, (Boolean?) -> Map<Int, Float>>): Map<List<Duration?>?, (DataSize?) -> Map<Any, Number>> = Undefined()
|
||||
}
|
||||
28
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classMethodTypeReferences.pkl
vendored
Normal file
28
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classMethodTypeReferences.pkl
vendored
Normal file
@@ -0,0 +1,28 @@
|
||||
/// Class methods whose types reference classes from
|
||||
/// the same module, a different module, and external modules.
|
||||
module com.package1.classMethodTypeReferences
|
||||
|
||||
import "shared.pkl"
|
||||
|
||||
import "../com.externalpackage/external1.pkl"
|
||||
|
||||
import "../com.externalpackage/external2.pkl"
|
||||
|
||||
class MyClass
|
||||
|
||||
class TypeReferences {
|
||||
/// Method with intra-module types.
|
||||
function method1(arg1: MyClass, arg2: MyClass): MyClass = Undefined()
|
||||
|
||||
/// Method with inter-module types.
|
||||
function method2(arg1: shared.MyClass, arg2: shared.MyClass): shared.MyClass = Undefined()
|
||||
|
||||
/// Method with external-module types.
|
||||
function method3(arg1: external1.MyClass, arg2: external2.MyClass): List<external1.MyClass> = Undefined()
|
||||
|
||||
/// Method with intra-module, inter-module, and external-module types.
|
||||
function method4(arg1: MyClass, arg2: shared.MyClass): external1.MyClass = Undefined()
|
||||
|
||||
/// Method with complex intra-module, inter-module, and external-module types.
|
||||
function method5(arg1: MyClass?, arg2: Map<shared.MyClass, external1.MyClass>): (external1.MyClass) -> external2.MyClass = Undefined()
|
||||
}
|
||||
13
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classPropertyAnnotations.pkl
vendored
Normal file
13
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classPropertyAnnotations.pkl
vendored
Normal file
@@ -0,0 +1,13 @@
|
||||
module com.package1.classPropertyAnnotations
|
||||
|
||||
class UserDefinedAnnotation extends Annotation {
|
||||
messageOpt: String?
|
||||
messageReq: String
|
||||
}
|
||||
|
||||
class ClassWithAnnotatedProperty {
|
||||
@UserDefinedAnnotation {
|
||||
messageReq = "Hi!"
|
||||
}
|
||||
propertyUserDefinedAnnotation: Int = 42
|
||||
}
|
||||
33
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classPropertyComments.pkl
vendored
Normal file
33
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classPropertyComments.pkl
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
/// Class properties with different kinds of comments.
|
||||
module com.package1.classPropertyComments
|
||||
|
||||
class Comments {
|
||||
// Property with single-line code comment.
|
||||
property1: Float = 3.14159265359
|
||||
|
||||
/*
|
||||
Property with
|
||||
multi-line
|
||||
code comment.
|
||||
*/
|
||||
property2: Float = 3.14159265359
|
||||
|
||||
/// Property with single-line doc comment.
|
||||
property3: Float = 3.14159265359
|
||||
|
||||
/// Property with
|
||||
/// multi-line
|
||||
/// doc comment.
|
||||
property4: Float = 3.14159265359
|
||||
|
||||
/// Property with [single-line](https://apple.com) *Markdown* doc comment.
|
||||
property5: Float = 3.14159265359
|
||||
|
||||
/// Property with
|
||||
/// [multi-line](https://apple.com)
|
||||
/// *Markdown* doc comment.
|
||||
property6: Float = 3.14159265359
|
||||
|
||||
/// 😀😀😀 Property with 😎😎😎 Unicode doc comment. 😡😡😡
|
||||
property7: Float = 3.14159265359
|
||||
}
|
||||
21
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classPropertyModifiers.pkl
vendored
Normal file
21
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classPropertyModifiers.pkl
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
/// Class properties with different modifiers.
|
||||
module com.package1.classPropertyModifiers
|
||||
|
||||
abstract class Modifiers {
|
||||
/// Property with `local` modifier.
|
||||
local property1 = 3.14159265359
|
||||
|
||||
/// Property with `hidden` modifier.
|
||||
hidden property2: Float = 3.14159265359
|
||||
|
||||
/// Property with `abstract` modifier.
|
||||
abstract property3: Float
|
||||
|
||||
/// Property with multiple modifiers.
|
||||
abstract hidden property4: Float
|
||||
|
||||
/*
|
||||
/// Property with `external` modifier.
|
||||
external property5: Float
|
||||
*/
|
||||
}
|
||||
34
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classPropertyTypeAnnotations.pkl
vendored
Normal file
34
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classPropertyTypeAnnotations.pkl
vendored
Normal file
@@ -0,0 +1,34 @@
|
||||
/// Class properties with different kinds of type annotations.
|
||||
module com.package1.classPropertyTypeAnnotations
|
||||
|
||||
class TypeAnnotations {
|
||||
/// Property without declared type.
|
||||
property1 = 3.14159265359
|
||||
|
||||
/// Property with simple type.
|
||||
property2: Float = 3.14159265359
|
||||
|
||||
/// Property with list type.
|
||||
property3: List<String> = List("1", "2", "3")
|
||||
|
||||
/// Property with set type.
|
||||
property4: Set<String> = Set("1", "2", "3")
|
||||
|
||||
/// Property with map type.
|
||||
property5: Map<String, Duration> = Map("one", 1.s, "two", 2.min, "three", 3.h)
|
||||
|
||||
/// Property with optional type.
|
||||
property6: String? = "string"
|
||||
|
||||
/// Property with zero-arg function type.
|
||||
property7: () -> String = () -> "string"
|
||||
|
||||
/// Property with one-arg function type.
|
||||
property8: (String) -> Int = (str) -> str.length
|
||||
|
||||
/// Property with two-arg function type.
|
||||
property9: (String, String) -> Int = (str1, str2) -> str1.length + str2.length
|
||||
|
||||
/// Property with complex type.
|
||||
property10: Map<List<String?>?, (Boolean?) -> Map<Int, Float>> = Map(List("str"), (b) -> Map(3, 3.0))
|
||||
}
|
||||
38
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classPropertyTypeReferences.pkl
vendored
Normal file
38
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classPropertyTypeReferences.pkl
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
/// Class properties whose types reference classes from
|
||||
/// the same module, a different module, and external modules.
|
||||
module com.package1.classPropertyTypeReferences
|
||||
|
||||
import "shared.pkl"
|
||||
|
||||
import "../com.externalpackage/external1.pkl"
|
||||
|
||||
class MyClass
|
||||
|
||||
class TypeReferences {
|
||||
/// Property with intra-module simple type.
|
||||
property1: MyClass = new MyClass {}
|
||||
|
||||
/// Property with inter-module list type.
|
||||
property2: List<shared.MyClass> = List(new shared.MyClass {})
|
||||
|
||||
/// Property with external-module set type.
|
||||
property3: Set<external1.MyClass> = Set(new external1.MyClass {})
|
||||
|
||||
/// Property with intra-module and inter-module map type.
|
||||
property4: Map<MyClass, shared.MyClass> = Map(new MyClass {}, new shared.MyClass {})
|
||||
|
||||
/// Property with external-module optional type.
|
||||
property5: external1.MyClass? = new external1.MyClass {}
|
||||
|
||||
/// Property with zero-arg intra-module function type.
|
||||
property6: () -> MyClass = () -> new MyClass {}
|
||||
|
||||
/// Property with one-arg inter-module and external-module function type.
|
||||
property7: (shared.MyClass) -> external1.MyClass = (myClass) -> new external1.MyClass {}
|
||||
|
||||
/// Property with two-arg intra-module, inter-module, and external-module function type.
|
||||
property8: (MyClass, shared.MyClass) -> external1.MyClass = (myClass1, myClass2) -> new external1.MyClass {}
|
||||
|
||||
/// Property with intra-module mapping type.
|
||||
property9: Mapping<String, MyClass>
|
||||
}
|
||||
24
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classTypeConstraints.pkl
vendored
Normal file
24
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/classTypeConstraints.pkl
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
module com.package1.classTypeConstraints
|
||||
|
||||
class Person1 {
|
||||
name: String(length >= 3)
|
||||
address: Address(street != city)
|
||||
}
|
||||
|
||||
emailAddress = (str) -> str.matches(Regex(#".+@.+"#))
|
||||
|
||||
class Person2 {
|
||||
email: String(emailAddress)
|
||||
}
|
||||
|
||||
class Address {
|
||||
street: String(!isEmpty)
|
||||
city: String = "San Francisco"
|
||||
}
|
||||
|
||||
class Project {
|
||||
// constraint for element type of optional type
|
||||
type: String(oneOf(List("open-source", "closed-source")))?
|
||||
// constraints for map type and its constituent key/value types
|
||||
contacts: Map<String(!isEmpty), String(emailAddress)>(length > 10, length < 20)
|
||||
}
|
||||
48
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/doc-package-info.pkl
vendored
Normal file
48
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/doc-package-info.pkl
vendored
Normal file
@@ -0,0 +1,48 @@
|
||||
/// Docs for Package 1.
|
||||
///
|
||||
/// * [docLinks]
|
||||
/// * [docLinks.age]
|
||||
/// * [docLinks.sing()]
|
||||
/// * [docLinks.Person]
|
||||
/// * [docLinks.Person.name]
|
||||
/// * [docLinks.PersonList]
|
||||
///
|
||||
/// * [external1]
|
||||
/// * [external1.MyClass]
|
||||
@Deprecated { message = "com.package1 is deprecated" }
|
||||
amends "pkl:DocPackageInfo"
|
||||
|
||||
import "docLinks.pkl"
|
||||
import "../com.externalpackage/external1.pkl"
|
||||
|
||||
name = "com.package1"
|
||||
version = "1.2.3"
|
||||
importUri = "https://pkl.io/"
|
||||
authors {
|
||||
"package1-publisher@group.apple.com"
|
||||
}
|
||||
sourceCode = "https://example.com/package1/"
|
||||
sourceCodeUrlScheme = "https://example.com/package1%{path}#L%{line}-L%{endLine}"
|
||||
issueTracker = "https://issues.apple.com/package1/"
|
||||
|
||||
dependencies {
|
||||
new {
|
||||
name = "com.package2"
|
||||
version = "4.5.6"
|
||||
sourceCode = "https://example.com/package2/"
|
||||
}
|
||||
new {
|
||||
name = "com.externalpackage"
|
||||
version = "7.8.9"
|
||||
sourceCode = "https://example.com/externalpackage/"
|
||||
documentation = "https://example.com/docs/externalpackage/"
|
||||
}
|
||||
new {
|
||||
name = "pkl"
|
||||
// use fixed version to avoid churn in expected test outputs
|
||||
version = "0.24.0"
|
||||
sourceCode = "https://github.com/apple/pkl/blob/dev/stdlib/"
|
||||
sourceCodeUrlScheme = "https://github.com/apple/pkl/blob/0.24.0/stdlib%{path}#L%{line}-L%{endLine}"
|
||||
documentation = "https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/"
|
||||
}
|
||||
}
|
||||
13
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/docExample.pkl
vendored
Normal file
13
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/docExample.pkl
vendored
Normal file
@@ -0,0 +1,13 @@
|
||||
@DocExample {
|
||||
subjects {
|
||||
"com.package1.docExampleSubject1"
|
||||
"com.package1.docExampleSubject2"
|
||||
}
|
||||
}
|
||||
module com.package1.docExample
|
||||
|
||||
amends "docExampleSubject1.pkl"
|
||||
|
||||
import "docExampleSubject2.pkl"
|
||||
|
||||
x = docExampleSubject2.y
|
||||
6
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/docExample2.pkl
vendored
Normal file
6
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/docExample2.pkl
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
@DocExample { subjects { "com.package1.docExampleSubject1" } }
|
||||
module com.package1.docExample2
|
||||
|
||||
amends "docExampleSubject1.pkl"
|
||||
|
||||
x = 42
|
||||
3
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/docExampleSubject1.pkl
vendored
Normal file
3
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/docExampleSubject1.pkl
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
module com.package1.docExampleSubject1
|
||||
|
||||
x: Int
|
||||
3
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/docExampleSubject2.pkl
vendored
Normal file
3
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/docExampleSubject2.pkl
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
module com.package1.docExampleSubject2
|
||||
|
||||
y: Int
|
||||
84
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/docLinks.pkl
vendored
Normal file
84
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/docLinks.pkl
vendored
Normal file
@@ -0,0 +1,84 @@
|
||||
/// [external1], [external1.MyClass]
|
||||
/// [shared], [shared.MyClass]
|
||||
/// [age], [sing()], [Person], [Person.name], [Person.call()], [PersonList]
|
||||
/// [docLinks], [docLinks.age], [docLinks.sing()],
|
||||
/// [docLinks.Person], [docLinks.Person.name], [docLinks.PersonList],
|
||||
/// [custom *link* text][docLinks.sing()]
|
||||
/// [module], [module.age], [module.sing()],
|
||||
/// [module.Person], [module.Person.name], [module.PersonList],
|
||||
/// [custom *link* text][module.sing()]
|
||||
module com.package1.docLinks
|
||||
|
||||
import "../com.externalpackage/external1.pkl"
|
||||
import "shared.pkl"
|
||||
import "docLinks.pkl"
|
||||
|
||||
/// [external1], [external1.MyClass]
|
||||
/// [shared], [shared.MyClass]
|
||||
/// [age], [sing()], [Person], [Person.name], [Person.call()], [PersonList]
|
||||
/// [docLinks], [docLinks.age], [docLinks.sing()],
|
||||
/// [docLinks.Person], [docLinks.Person.name], [docLinks.PersonList],
|
||||
/// [custom *link* text][docLinks.sing()]
|
||||
/// [module], [module.age], [module.sing()],
|
||||
/// [module.Person], [module.Person.name], [module.PersonList],
|
||||
/// [custom *link* text][module.sing()]
|
||||
age: Int
|
||||
|
||||
/// [external1], [external1.MyClass]
|
||||
/// [shared], [shared.MyClass]
|
||||
/// [age], [sing()], [Person], [Person.name], [Person.call()], [PersonList]
|
||||
/// [docLinks], [docLinks.age], [docLinks.sing()],
|
||||
/// [docLinks.Person], [docLinks.Person.name], [docLinks.PersonList],
|
||||
/// [custom *link* text][docLinks.sing()]
|
||||
/// [module], [module.age], [module.sing()],
|
||||
/// [module.Person], [module.Person.name], [module.PersonList],
|
||||
/// [custom *link* text][module.sing()]
|
||||
/// [song]
|
||||
function sing(song: String) = "tra-la-la"
|
||||
|
||||
/// [external1], [external1.MyClass]
|
||||
/// [shared], [shared.MyClass]
|
||||
/// [age], [sing()], [Person], [Person.name], [Person.call()], [Person.call()], [PersonList]
|
||||
/// [docLinks], [docLinks.age], [docLinks.sing()],
|
||||
/// [docLinks.Person], [docLinks.Person.name], [docLinks.PersonList],
|
||||
/// [custom *link* text][docLinks.sing()]
|
||||
/// [module], [module.age], [module.sing()],
|
||||
/// [module.Person], [module.Person.name], [module.PersonList],
|
||||
/// [custom *link* text][module.sing()]
|
||||
/// [name], [call()]
|
||||
class Person {
|
||||
/// [external1], [external1.MyClass]
|
||||
/// [age], [sing()], [Person], [Person.name], [Person.call()], [PersonList]
|
||||
/// [docLinks], [docLinks.age], [docLinks.sing()],
|
||||
/// [docLinks.Person], [docLinks.Person.name], [docLinks.PersonList],
|
||||
/// [custom *link* text][docLinks.sing()]
|
||||
/// [module], [module.age], [module.sing()],
|
||||
/// [module.Person], [module.Person.name], [module.PersonList],
|
||||
/// [custom *link* text][module.sing()]
|
||||
/// [name], [call()]
|
||||
name: String
|
||||
|
||||
/// [external1], [external1.MyClass]
|
||||
/// [shared], [shared.MyClass]
|
||||
/// [age], [sing()], [Person], [Person.name], [Person.call()], [PersonList]
|
||||
/// [docLinks], [docLinks.age], [docLinks.sing()],
|
||||
/// [docLinks.Person], [docLinks.Person.name], [docLinks.PersonList],
|
||||
/// [custom *link* text][docLinks.sing()]
|
||||
/// [module], [module.age], [module.sing()],
|
||||
/// [module.Person], [module.Person.name], [module.PersonList],
|
||||
/// [custom *link* text][module.sing()]
|
||||
/// [name], [call()]
|
||||
/// [number]
|
||||
function call(number: String) = "calling $number"
|
||||
}
|
||||
|
||||
/// [external1], [external1.MyClass]
|
||||
/// [shared], [shared.MyClass]
|
||||
/// [age], [sing()], [Person], [Person.name], [Person.call()], [PersonList]
|
||||
/// [docLinks], [docLinks.age], [docLinks.sing()],
|
||||
/// [docLinks.Person], [docLinks.Person.name], [docLinks.PersonList],
|
||||
/// [custom *link* text][docLinks.sing()]
|
||||
/// [module], [module.age], [module.sing()],
|
||||
/// [module.Person], [module.Person.name], [module.PersonList],
|
||||
/// [custom *link* text][module.sing()]
|
||||
typealias PersonList = List<Person>
|
||||
31
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/methodAnnotations.pkl
vendored
Normal file
31
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/methodAnnotations.pkl
vendored
Normal file
@@ -0,0 +1,31 @@
|
||||
module com.package1.methodAnnotations
|
||||
|
||||
/// This [mthod()] thought to have a correctly spelled name.
|
||||
@Deprecated {
|
||||
message = "Spelling mistake."
|
||||
replaceWith = "method()"
|
||||
}
|
||||
@AlsoKnownAs {
|
||||
names { "function" }
|
||||
}
|
||||
function mthod(): Int = 42
|
||||
|
||||
|
||||
/// This [mthod()] thought to have a correctly spelled name.
|
||||
///
|
||||
/// Unfortunately, it did not, as we explain in this expandable comment.
|
||||
@Deprecated {
|
||||
message = "Spelling mistake."
|
||||
replaceWith = "method()"
|
||||
}
|
||||
@AlsoKnownAs {
|
||||
names { "function" }
|
||||
}
|
||||
function mthodWithExpandableComment(): Int = 42
|
||||
|
||||
|
||||
// This [method()] indeed has a properly spelled name, but no doc comment.
|
||||
@AlsoKnownAs {
|
||||
names { "function" }
|
||||
}
|
||||
function method(): Int = 42
|
||||
54
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleComments.pkl
vendored
Normal file
54
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleComments.pkl
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
/// The greatest breakthrough since ever.
|
||||
///
|
||||
/// ### Installation
|
||||
///
|
||||
/// Just follow these simple steps:
|
||||
///
|
||||
/// 1. Install it
|
||||
/// 1. I promise it's easy.
|
||||
/// 2. You'll figure it out.
|
||||
/// 1. Install it
|
||||
/// ```
|
||||
/// name = "Pigeon"
|
||||
/// age = 42
|
||||
/// ```
|
||||
/// 1. Install it
|
||||
///
|
||||
/// Let me **emphasize** how *simple* this is.
|
||||
///
|
||||
/// 😀😀😀 emoji day 😎😎😎 don't get 😡😡😡
|
||||
///
|
||||
/// ### Code
|
||||
///
|
||||
/// The code is beautiful:
|
||||
///
|
||||
/// ```
|
||||
/// /// example module
|
||||
/// module foo.bar
|
||||
///
|
||||
/// person {
|
||||
/// name = "Pigeon"
|
||||
/// age = 42
|
||||
/// }
|
||||
///
|
||||
/// function sing() = "tra-la-la"
|
||||
///
|
||||
/// class Person {
|
||||
/// name: String
|
||||
/// age: Int
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// ### Random Tips
|
||||
///
|
||||
/// - don't give up
|
||||
/// - just don't
|
||||
/// - don't give up
|
||||
///
|
||||
/// # Level 1
|
||||
/// ## Level 2
|
||||
/// ### Level 3
|
||||
/// #### Level 4
|
||||
/// ##### Level 5
|
||||
/// ###### Level 6
|
||||
module com.package1.moduleComments
|
||||
9
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleExtend.pkl
vendored
Normal file
9
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleExtend.pkl
vendored
Normal file
@@ -0,0 +1,9 @@
|
||||
module com.package1.moduleExtend
|
||||
|
||||
extends "baseModule.pkl"
|
||||
|
||||
extendProperty = 42
|
||||
|
||||
function extendMethod() = 42
|
||||
|
||||
class ExtendClass {}
|
||||
2
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleInfoAnnotation.pkl
vendored
Normal file
2
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleInfoAnnotation.pkl
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
@ModuleInfo { minPklVersion = "0.10.0" }
|
||||
module com.package1.moduleInfoAnnotation
|
||||
@@ -0,0 +1,5 @@
|
||||
module com.package1.moduleMethodCommentInheritance
|
||||
|
||||
extends "moduleMethodComments.pkl"
|
||||
|
||||
function method3(arg: String): Boolean = Undefined()
|
||||
31
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleMethodComments.pkl
vendored
Normal file
31
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleMethodComments.pkl
vendored
Normal file
@@ -0,0 +1,31 @@
|
||||
/// Module methods with different kinds of comments.
|
||||
open module com.package1.moduleMethodComments
|
||||
|
||||
// Method with single-line code comment.
|
||||
function method1(): Float = Undefined()
|
||||
|
||||
/*
|
||||
Method with
|
||||
multi-line
|
||||
code comment.
|
||||
*/
|
||||
function method2(): Float = Undefined()
|
||||
|
||||
/// Method with single-line doc comment.
|
||||
function method3(): Float = Undefined()
|
||||
|
||||
/// Method with
|
||||
/// multi-line
|
||||
/// doc comment.
|
||||
function method4(): Float = Undefined()
|
||||
|
||||
/// Method with [single-line](https://apple.com) *Markdown* doc comment.
|
||||
function method5(): Float = Undefined()
|
||||
|
||||
/// Method with
|
||||
/// [multi-line](https://apple.com)
|
||||
/// *Markdown* doc comment.
|
||||
function method6(): Float = Undefined()
|
||||
|
||||
/// 😀😀😀 Method with 😎😎😎 Unicode doc comment. 😡😡😡
|
||||
function method7(): Float = Undefined()
|
||||
13
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleMethodModifiers.pkl
vendored
Normal file
13
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleMethodModifiers.pkl
vendored
Normal file
@@ -0,0 +1,13 @@
|
||||
/// Module methods with different modifiers.
|
||||
module com.package1.moduleMethodModifiers
|
||||
|
||||
/// Method with `abstract` modifier.
|
||||
abstract function method1(arg: String): Boolean
|
||||
|
||||
/*
|
||||
/// Method with `external` modifier.
|
||||
external function method2(arg: String): Boolean
|
||||
|
||||
/// Method with multiple modifiers.
|
||||
abstract external function method3(arg: String): Boolean
|
||||
*/
|
||||
41
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleMethodTypeAnnotations.pkl
vendored
Normal file
41
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleMethodTypeAnnotations.pkl
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
/// Module methods with different kinds of type annotations.
|
||||
module com.package1.moduleMethodTypeAnnotations
|
||||
|
||||
/// Zero-arg method without declared types.
|
||||
function method1() = Undefined()
|
||||
|
||||
/// One-arg method without declared types.
|
||||
function method2(arg1) = Undefined()
|
||||
|
||||
/// Two-arg method without declared types.
|
||||
function method3(arg1, arg2) = Undefined()
|
||||
|
||||
/// Zero-arg method with simple types.
|
||||
function method4(): String = Undefined()
|
||||
|
||||
/// One-arg method with simple types.
|
||||
function method5(arg1: Boolean): Int = Undefined()
|
||||
|
||||
/// Two-arg method with simple types.
|
||||
function method6(arg1: Int, arg2: Float): Duration = Undefined()
|
||||
|
||||
/// Two-arg method with list types.
|
||||
function method7(arg1: List<Int>, arg2: List<Float>): List<Duration> = Undefined()
|
||||
|
||||
/// Two-arg method with set types.
|
||||
function method8(arg1: Set<Int>, arg2: Set<Float>): Set<Duration> = Undefined()
|
||||
|
||||
/// Two-arg method with map types.
|
||||
function method9(arg1: Map<Int, Int>, arg2: Map<Float, Float>): Map<Duration, Duration> = Undefined()
|
||||
|
||||
/// Two-arg method with optional types.
|
||||
function method10(arg1: Int?, arg2: Float?): Duration? = Undefined()
|
||||
|
||||
/// Two-arg method with function types.
|
||||
function method11(arg1: () -> Int, arg2: (Int) -> Float): (Int, Float) -> Duration = Undefined()
|
||||
|
||||
/// Two-arg method with partially declared types.
|
||||
function method12(arg1: String, arg2): Boolean = Undefined()
|
||||
|
||||
/// One-arg method with complex types.
|
||||
function method13(arg1: Map<List<String?>?, (Boolean?) -> Map<Int, Float>>): Map<List<Duration?>?, (DataSize?) -> Map<Any, Number>> = Undefined()
|
||||
26
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleMethodTypeReferences.pkl
vendored
Normal file
26
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleMethodTypeReferences.pkl
vendored
Normal file
@@ -0,0 +1,26 @@
|
||||
/// Module methods whose types reference classes from
|
||||
/// the same module, a different module, and external modules.
|
||||
module com.package1.moduleMethodTypeReferences
|
||||
|
||||
import "shared.pkl"
|
||||
|
||||
import "../com.externalpackage/external1.pkl"
|
||||
|
||||
import "../com.externalpackage/external2.pkl"
|
||||
|
||||
class MyClass
|
||||
|
||||
/// Method with intra-module types.
|
||||
function method1(arg1: MyClass, arg2: MyClass): MyClass = Undefined()
|
||||
|
||||
/// Method with inter-module types.
|
||||
function method2(arg1: shared.MyClass, arg2: shared.MyClass): shared.MyClass = Undefined()
|
||||
|
||||
/// Method with external-module types.
|
||||
function method3(arg1: external1.MyClass, arg2: external2.MyClass): List<external1.MyClass> = Undefined()
|
||||
|
||||
/// Method with intra-module, inter-module, and external-module types.
|
||||
function method4(arg1: MyClass, arg2: shared.MyClass): external1.MyClass = Undefined()
|
||||
|
||||
/// Method with complex intra-module, inter-module, and external-module types.
|
||||
function method5(arg1: MyClass?, arg2: Map<shared.MyClass, external1.MyClass>): (external1.MyClass) -> external2.MyClass = Undefined()
|
||||
77
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/modulePropertyAnnotations.pkl
vendored
Normal file
77
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/modulePropertyAnnotations.pkl
vendored
Normal file
@@ -0,0 +1,77 @@
|
||||
module com.package1.modulePropertyAnnotations
|
||||
|
||||
/// This [prperty] thought to have a correctly spelled name.
|
||||
@Deprecated {
|
||||
message = "Spelling mistake."
|
||||
replaceWith = "property"
|
||||
}
|
||||
@AlsoKnownAs {
|
||||
names { "field"; "item" }
|
||||
}
|
||||
hidden prperty = 42
|
||||
|
||||
|
||||
/// This [prperty] thought to have a correctly spelled name.
|
||||
///
|
||||
/// Unfortunately, it did not, as we explain in this expandable comment.
|
||||
@Deprecated {
|
||||
message = "Spelling mistake."
|
||||
replaceWith = "property"
|
||||
}
|
||||
@AlsoKnownAs {
|
||||
names { "field"; "item" }
|
||||
}
|
||||
hidden prpertyWithExpandableComment = 42
|
||||
|
||||
|
||||
// This [property] indeed has a properly spelled name, but no doc comment.
|
||||
@AlsoKnownAs {
|
||||
names { "field"; "item" }
|
||||
}
|
||||
hidden property = 42
|
||||
|
||||
|
||||
|
||||
|
||||
class UserDefinedAnnotation extends Annotation {
|
||||
messageOpt: String?
|
||||
messageReq: String
|
||||
}
|
||||
|
||||
@UserDefinedAnnotation {
|
||||
messageReq = "Hi!"
|
||||
}
|
||||
propertyUserDefinedAnnotation: Int = 42
|
||||
|
||||
|
||||
|
||||
|
||||
class UserDefinedAnnotation1 extends Annotation {
|
||||
nested: UserDefinedAnnotation
|
||||
}
|
||||
|
||||
@UserDefinedAnnotation1 {
|
||||
nested = new UserDefinedAnnotation {
|
||||
messageReq = "Hi!"
|
||||
}
|
||||
}
|
||||
propertyUserDefinedAnnotation1: Int = 42
|
||||
|
||||
|
||||
|
||||
|
||||
class UserDefinedAnnotation2 extends Annotation {
|
||||
nested: UserDefinedAnnotation2?
|
||||
}
|
||||
|
||||
@UserDefinedAnnotation2 {
|
||||
nested = new UserDefinedAnnotation2 {
|
||||
nested = new UserDefinedAnnotation2 {
|
||||
nested = new UserDefinedAnnotation2 {
|
||||
nested = new UserDefinedAnnotation2 {
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
propertyUserDefinedAnnotation2: Int = 42
|
||||
@@ -0,0 +1,5 @@
|
||||
module com.package1.modulePropertyCommentInheritance
|
||||
|
||||
extends "modulePropertyComments.pkl"
|
||||
|
||||
property3: Float = 1.23
|
||||
54
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/modulePropertyComments.pkl
vendored
Normal file
54
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/modulePropertyComments.pkl
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
/// Module properties with different kinds of comments.
|
||||
open module com.package1.modulePropertyComments
|
||||
|
||||
// Property with single-line code comment.
|
||||
property1: Float = 3.14159265359
|
||||
|
||||
/*
|
||||
Property with
|
||||
multi-line
|
||||
code comment.
|
||||
*/
|
||||
property2: Float = 3.14159265359
|
||||
|
||||
/// Property with single-line doc comment.
|
||||
property3: Float = 3.14159265359
|
||||
|
||||
/// Property with
|
||||
/// multi-line
|
||||
/// doc comment.
|
||||
property4: Float = 3.14159265359
|
||||
|
||||
/// Property with [single-line](https://apple.com) *Markdown* doc comment.
|
||||
property5: Float = 3.14159265359
|
||||
|
||||
/// Property with
|
||||
/// [multi-line](https://apple.com)
|
||||
/// *Markdown* doc comment.
|
||||
property6: Float = 3.14159265359
|
||||
|
||||
/// 😀😀😀 Property with 😎😎😎 Unicode doc comment. 😡😡😡
|
||||
property7: Float = 3.14159265359
|
||||
|
||||
/// Summary
|
||||
/// ```
|
||||
///
|
||||
/// code = 4 * 10
|
||||
/// ```
|
||||
/// Rest of the body
|
||||
property8: Int = 0
|
||||
|
||||
/// Sumary
|
||||
/// ```java
|
||||
///
|
||||
/// code = 0
|
||||
/// ```
|
||||
/// Rest
|
||||
property9: Int = 1
|
||||
|
||||
/// ```
|
||||
///
|
||||
/// code = 2
|
||||
/// ```
|
||||
/// Rest
|
||||
property10: Int = 2
|
||||
19
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/modulePropertyModifiers.pkl
vendored
Normal file
19
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/modulePropertyModifiers.pkl
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
/// Module properties with different modifiers.
|
||||
module com.package1.modulePropertyModifiers
|
||||
|
||||
/// Property with `local` modifier.
|
||||
local property1 = 3.14159265359
|
||||
|
||||
/// Property with `hidden` modifier.
|
||||
hidden property2: Float = 3.14159265359
|
||||
|
||||
/*
|
||||
/// Property with `external` modifier.
|
||||
external property3: Float
|
||||
|
||||
/// Property with `abstract` modifier.
|
||||
abstract property4: Float
|
||||
|
||||
/// Property with multiple modifiers.
|
||||
abstract external hidden property5: Float
|
||||
*/
|
||||
32
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/modulePropertyTypeAnnotations.pkl
vendored
Normal file
32
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/modulePropertyTypeAnnotations.pkl
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
/// Module properties with different kinds of type annotations.
|
||||
module com.package1.modulePropertyTypeAnnotations
|
||||
|
||||
/// Property without declared type.
|
||||
property1 = 3.14159265359
|
||||
|
||||
/// Property with simple type.
|
||||
property2: Float = 3.14159265359
|
||||
|
||||
/// Property with list type.
|
||||
property3: List<String> = List("1", "2", "3")
|
||||
|
||||
/// Property with set type.
|
||||
property4: Set<String> = Set("1", "2", "3")
|
||||
|
||||
/// Property with map type.
|
||||
property5: Map<String, Duration> = Map("one", 1.s, "two", 2.min, "three", 3.h)
|
||||
|
||||
/// Property with optional type.
|
||||
property6: String? = "string"
|
||||
|
||||
/// Property with zero-arg function type.
|
||||
property7: () -> String = () -> "string"
|
||||
|
||||
/// Property with one-arg function type.
|
||||
property8: (String) -> Int = (str) -> str.length
|
||||
|
||||
/// Property with two-arg function type.
|
||||
property9: (String, String) -> Int = (str1, str2) -> str1.length + str2.length
|
||||
|
||||
/// Property with complex type.
|
||||
property10: Map<List<String?>?, (Boolean?) -> Map<Int, Float>> = Map(List("str"), (b) -> Map(3, 3.0))
|
||||
36
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/modulePropertyTypeReferences.pkl
vendored
Normal file
36
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/modulePropertyTypeReferences.pkl
vendored
Normal file
@@ -0,0 +1,36 @@
|
||||
/// Module properties whose types reference classes from
|
||||
/// the same module, a different module, and external modules.
|
||||
module com.package1.modulePropertyTypeReferences
|
||||
|
||||
import "shared.pkl"
|
||||
|
||||
import "../com.externalpackage/external1.pkl"
|
||||
|
||||
class MyClass
|
||||
|
||||
/// Property with intra-module simple type.
|
||||
property1: MyClass = new MyClass {}
|
||||
|
||||
/// Property with inter-module list type.
|
||||
property2: List<shared.MyClass> = List(new shared.MyClass {})
|
||||
|
||||
/// Property with external-module set type.
|
||||
property3: Set<external1.MyClass> = Set(new external1.MyClass {})
|
||||
|
||||
/// Property with intra-module and inter-module map type.
|
||||
property4: Map<MyClass, shared.MyClass> = Map(new MyClass {}, new shared.MyClass {})
|
||||
|
||||
/// Property with external-module optional type.
|
||||
property5: external1.MyClass? = new external1.MyClass {}
|
||||
|
||||
/// Property with zero-arg intra-module function type.
|
||||
property6: () -> MyClass = () -> new MyClass {}
|
||||
|
||||
/// Property with one-arg inter-module and external-module function type.
|
||||
property7: (shared.MyClass) -> external1.MyClass = (myClass) -> new external1.MyClass {}
|
||||
|
||||
/// Property with two-arg intra-module, inter-module, and external-module function type.
|
||||
property8: (MyClass, shared.MyClass) -> external1.MyClass = (myClass1, myClass2) -> new external1.MyClass {}
|
||||
|
||||
/// Property with intra-module mapping type.
|
||||
property9: Mapping<String, MyClass>
|
||||
3
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleTypes1.pkl
vendored
Normal file
3
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleTypes1.pkl
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
module com.package1.moduleTypes1
|
||||
|
||||
n: Int
|
||||
37
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleTypes2.pkl
vendored
Normal file
37
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleTypes2.pkl
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
module com.package1.moduleTypes2
|
||||
|
||||
import "moduleTypes1.pkl"
|
||||
|
||||
x1: moduleTypes1
|
||||
|
||||
x2: moduleTypes1?
|
||||
|
||||
x3: Listing<moduleTypes1>
|
||||
|
||||
x4: Mapping<moduleTypes1, moduleTypes1>
|
||||
|
||||
x5: String|moduleTypes1|Int
|
||||
|
||||
x6: module
|
||||
|
||||
x7: List<module>
|
||||
|
||||
x8: String|module|Int
|
||||
|
||||
class Foo {
|
||||
x1: moduleTypes1
|
||||
|
||||
x2: moduleTypes1?
|
||||
|
||||
x3: Listing<moduleTypes1>
|
||||
|
||||
x4: Mapping<moduleTypes1, moduleTypes1>
|
||||
|
||||
x5: String|moduleTypes1|Int
|
||||
|
||||
x6: module
|
||||
|
||||
x7: List<module>
|
||||
|
||||
x8: String|module|Int
|
||||
}
|
||||
7
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/nested/nested2/nestedModule.pkl
vendored
Normal file
7
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/nested/nested2/nestedModule.pkl
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
module com.package1.nested.nested2.nestedModule
|
||||
|
||||
myProperty = 42
|
||||
|
||||
function myMethod() = 42
|
||||
|
||||
class MyClass {}
|
||||
3
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/shared.pkl
vendored
Normal file
3
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/shared.pkl
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
module com.package1.shared
|
||||
|
||||
class MyClass
|
||||
31
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/typeAliases.pkl
vendored
Normal file
31
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/typeAliases.pkl
vendored
Normal file
@@ -0,0 +1,31 @@
|
||||
open module com.package1.typealiases
|
||||
|
||||
/// A [String] representing an [Email] address.
|
||||
@AlsoKnownAs { names { "OtherName" } }
|
||||
typealias Email = String(contains("@"))
|
||||
|
||||
uint: UInt
|
||||
|
||||
uints: List<UInt>
|
||||
|
||||
/// My [Email].
|
||||
email: Email
|
||||
|
||||
emails: List<Email>
|
||||
|
||||
/// Sends an [Email].
|
||||
function send(email: Email): Email = "abc"
|
||||
|
||||
open class Person {
|
||||
uint: UInt
|
||||
|
||||
list: List<UInt>
|
||||
|
||||
/// A person's [Email].
|
||||
email: Email
|
||||
|
||||
emails: List<Email>
|
||||
|
||||
/// Sends an [Email].
|
||||
function send(email: Email): Email = "abc"
|
||||
}
|
||||
32
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/typeAliases2.pkl
vendored
Normal file
32
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/typeAliases2.pkl
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
module com.package1.typealiases2
|
||||
|
||||
class Person { name: String }
|
||||
|
||||
typealias List2<E> = List<E>
|
||||
typealias Map2<V, K> = Map<K, V>
|
||||
typealias StringMap<V> = Map<String, V>
|
||||
typealias MMap<X> = Map<X, X>
|
||||
|
||||
res1: List2<Int>
|
||||
res2: List2<List2<String>>
|
||||
res3: Map2<String, Int>
|
||||
res4: StringMap<Duration>
|
||||
res5: MMap<Person?>
|
||||
|
||||
res6: List2
|
||||
res7: Map2
|
||||
res8: StringMap
|
||||
res9: MMap
|
||||
|
||||
class Foo {
|
||||
res1: List2<Int>
|
||||
res2: List2<List2<String>>
|
||||
res3: Map2<String, Int>
|
||||
res4: StringMap<Duration>
|
||||
res5: MMap<Person?>
|
||||
|
||||
res6: List2
|
||||
res7: Map2
|
||||
res8: StringMap
|
||||
res9: MMap
|
||||
}
|
||||
13
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/typeAliasesInheritance.pkl
vendored
Normal file
13
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/typeAliasesInheritance.pkl
vendored
Normal file
@@ -0,0 +1,13 @@
|
||||
module com.package1.typeAliasInheritance
|
||||
|
||||
extends "typeAliases.pkl"
|
||||
|
||||
email2: Email
|
||||
|
||||
emails2: List<Email>
|
||||
|
||||
class Person2 extends Person {
|
||||
email2: Email
|
||||
|
||||
emails2: List<Email>
|
||||
}
|
||||
13
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/unionTypes.pkl
vendored
Normal file
13
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/unionTypes.pkl
vendored
Normal file
@@ -0,0 +1,13 @@
|
||||
module com.package1.unionTypes
|
||||
|
||||
res1: Boolean|Number
|
||||
|
||||
res2: "foo"|"bar"|"baz"
|
||||
|
||||
res3: Boolean|List<String>
|
||||
|
||||
res4: Boolean|List<String>?
|
||||
|
||||
res5: (Boolean|List<String>)?
|
||||
|
||||
res6: (Boolean|List<String>)?|Number
|
||||
8
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/unlistedClass.pkl
vendored
Normal file
8
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/unlistedClass.pkl
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
module com.package1.unlistedClass
|
||||
|
||||
myProperty = 42
|
||||
|
||||
function myMethod() = 42
|
||||
|
||||
@Unlisted
|
||||
class MyClass {}
|
||||
8
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/unlistedMethod.pkl
vendored
Normal file
8
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/unlistedMethod.pkl
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
module com.package1.unlistedMethod
|
||||
|
||||
myProperty = 42
|
||||
|
||||
@Unlisted
|
||||
function myMethod() = 42
|
||||
|
||||
class MyClass {}
|
||||
8
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/unlistedModule.pkl
vendored
Normal file
8
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/unlistedModule.pkl
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
@Unlisted
|
||||
module com.package1.unlistedModule
|
||||
|
||||
myProperty = 42
|
||||
|
||||
function myMethod() = 42
|
||||
|
||||
class MyClass {}
|
||||
8
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/unlistedProperty.pkl
vendored
Normal file
8
pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/unlistedProperty.pkl
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
module com.package1.unlistedProperty
|
||||
|
||||
@Unlisted
|
||||
myProperty = 42
|
||||
|
||||
function myMethod() = 42
|
||||
|
||||
class MyClass {}
|
||||
11
pkl-doc/src/test/files/DocGeneratorTest/input/com.package2/Module3.pkl
vendored
Normal file
11
pkl-doc/src/test/files/DocGeneratorTest/input/com.package2/Module3.pkl
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
module com.package2.Module3
|
||||
|
||||
property3: String
|
||||
|
||||
function function3(n: Int): String = n.toString()
|
||||
|
||||
class Class3 {
|
||||
property3: String
|
||||
|
||||
function function3(n: Int): String = n.toString()
|
||||
}
|
||||
23
pkl-doc/src/test/files/DocGeneratorTest/input/com.package2/doc-package-info.pkl
vendored
Normal file
23
pkl-doc/src/test/files/DocGeneratorTest/input/com.package2/doc-package-info.pkl
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
/// Docs for Package 2.
|
||||
amends "pkl:DocPackageInfo"
|
||||
|
||||
name = "com.package2"
|
||||
version = "4.5.6"
|
||||
importUri = "modulepath:/com/package2/"
|
||||
authors {
|
||||
"package2-publisher@group.apple.com"
|
||||
}
|
||||
sourceCode = "https://sources.apple.com/package2/"
|
||||
sourceCodeUrlScheme = "https://example.com/blob/\(version)%{path}#L%{line}-L%{endLine}"
|
||||
issueTracker = "https://issues.apple.com/package2/"
|
||||
|
||||
dependencies {
|
||||
new {
|
||||
name = "pkl"
|
||||
// use fixed version to avoid churn in expected test outputs
|
||||
version = "0.24.0"
|
||||
sourceCode = "https://github.com/apple/\(name)/blob/dev/stdlib/"
|
||||
sourceCodeUrlScheme = "https://github.com/apple/\(name)/blob/\(version)/stdlib%{path}#L%{line}-L%{endLine}"
|
||||
documentation = "https://pkl-lang.org/stdlib/\(name)/\(version)/"
|
||||
}
|
||||
}
|
||||
65
pkl-doc/src/test/files/DocGeneratorTest/input/docsite-info.pkl
vendored
Normal file
65
pkl-doc/src/test/files/DocGeneratorTest/input/docsite-info.pkl
vendored
Normal file
@@ -0,0 +1,65 @@
|
||||
/// Let the games begin.
|
||||
///
|
||||
/// ## Great Library
|
||||
///
|
||||
/// Just follow these simple steps. You'll love it.
|
||||
///
|
||||
/// 1. Install it
|
||||
/// 1. I promise it's easy.
|
||||
/// 2. You'll figure it out.
|
||||
/// 1. Install it
|
||||
/// ```
|
||||
/// name = "Pigeon"
|
||||
/// age = 42
|
||||
/// ```
|
||||
/// 1. Install it
|
||||
///
|
||||
/// Let me **emphasize** how *simple* this is.
|
||||
///
|
||||
/// 😀😀😀 emoji day 😎😎😎 don't get 😡😡😡
|
||||
///
|
||||
/// ## Code
|
||||
///
|
||||
/// The code is beautiful:
|
||||
///
|
||||
/// ```
|
||||
/// /// example module
|
||||
/// module foo.bar
|
||||
///
|
||||
/// person {
|
||||
/// name = "Pigeon"
|
||||
/// age = 42
|
||||
/// }
|
||||
///
|
||||
/// function sing() = "tra-la-la"
|
||||
///
|
||||
/// class Person {
|
||||
/// name: String
|
||||
/// age: Int
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// ## Random Tips
|
||||
///
|
||||
/// - don't give up
|
||||
/// - just don't
|
||||
/// - don't give up
|
||||
///
|
||||
/// # Level 1
|
||||
/// ## Level 2
|
||||
/// ### Level 3
|
||||
/// #### Level 4
|
||||
/// ##### Level 5
|
||||
/// ###### Level 6
|
||||
///
|
||||
/// * [docLinks]
|
||||
/// * [docLinks.age]
|
||||
/// * [docLinks.sing()]
|
||||
/// * [docLinks.Person]
|
||||
/// * [docLinks.Person.name]
|
||||
/// * [docLinks.PersonList]
|
||||
amends "pkl:DocsiteInfo"
|
||||
|
||||
import "com.package1/docLinks.pkl"
|
||||
|
||||
title = "Docsite Title"
|
||||
150
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/baseModule/BaseClass.html
vendored
Normal file
150
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/baseModule/BaseClass.html
vendored
Normal file
@@ -0,0 +1,150 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>BaseClass (com.package1/baseModule:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/baseModule/BaseClass.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.baseModule" data-class-name="BaseClass" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.baseModule</a>
|
||||
<h1 id="declaration-title">BaseClass<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">BaseClass</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="BaseClass.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="BaseClass.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
235
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/baseModule/index.html
vendored
Normal file
235
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/baseModule/index.html
vendored
Normal file
@@ -0,0 +1,235 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>baseModule (com.package1:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/baseModule/index.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.baseModule" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a>
|
||||
<h1 id="declaration-title">com.package1.baseModule<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
<li><a href="#_classes">Classes</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">open module <span class="name-decl">com.package1.baseModule</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="">Module URI:</dt>
|
||||
<dd><span class="import-uri">https://pkl.io/baseModule.pkl</span><i class="copy-uri-button material-icons">content_copy</i></dd>
|
||||
<dt class="">Source code:</dt>
|
||||
<dd><a href="https://example.com/package1/baseModule.pkl">baseModule.pkl</a></dd>
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="output" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#output">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">output</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/ModuleOutput.html" class="name-ref">ModuleOutput</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The output of this module.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Defaults to all module properties rendered as either Pcf or the format specified on the command line.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="baseProperty" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#baseProperty">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">baseProperty</span>: unknown<a class="member-source-link" href="https://example.com/package1/baseModule.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="relativePathTo()" class="anchor"> </div>
|
||||
<div id="relativePathTo().other" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#relativePathTo()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">relativePathTo</span>(<span class="param1">other</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Module.html" class="name-ref">Module</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the relative, descendent directory path between this module and <code>other</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if no such path exists.</p>
|
||||
<p>For example, if module <code>mod1</code> has path <code>/dir1/mod1.pkl</code>, and module <code>mod2</code> has path <code>/dir1/dir2/dir3/mod2.pkl</code>,
|
||||
then <code>mod1.relativePathTo(mod2)</code> will return <code>List("dir2", "dir3")</code>.</p>
|
||||
<p>A common use case is to compute the directory path between a template located at the root of a hierarchy
|
||||
(say <code>rootModule.pkl</code>) and the currently evaluated module (accessible via the <code>module</code> keyword):</p>
|
||||
<pre><code>import "rootModule.pkl" // self-import
|
||||
path = rootModule.relativePathTo(module)
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="baseMethod()" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#baseMethod()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">baseMethod</span>(): unknown<a class="member-source-link" href="https://example.com/package1/baseModule.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_classes" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Classes</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="BaseClass" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#BaseClass">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="BaseClass.html" class="name-decl">BaseClass</a><a class="member-source-link" href="https://example.com/package1/baseModule.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,153 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>AnnotatedClass (com.package1/classAnnotations:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classAnnotations/AnnotatedClass.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classAnnotations" data-class-name="AnnotatedClass" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classAnnotations</a>
|
||||
<h1 id="declaration-title">AnnotatedClass<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature member-deprecated">class <span class="name-decl">AnnotatedClass</span></div>
|
||||
<div class="doc-comment">Deprecated.</div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
<dt>Also known as:</dt>
|
||||
<dd><code>OtherName</code></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="AnnotatedClass.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="AnnotatedClass.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,155 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>AnnotatedClss (com.package1/classAnnotations:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classAnnotations/AnnotatedClss.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classAnnotations" data-class-name="AnnotatedClss" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classAnnotations</a>
|
||||
<h1 id="declaration-title">AnnotatedClss<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_overview">Overview</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i>
|
||||
<div class="member-signature member-deprecated">class <span class="name-decl">AnnotatedClss</span></div>
|
||||
<div class="doc-comment">Deprecated: Spelling mistake. Replace with: <code>AnnotatedClass</code></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
<dt>Also known as:</dt>
|
||||
<dd><code>OtherName</code></dd>
|
||||
</dl>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This <code>AnnotatedClss</code> thought to have a correctly spelled name.</p></div>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="AnnotatedClss.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="AnnotatedClss.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,155 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>AnnotatedClssWithExpandableComment (com.package1/classAnnotations:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classAnnotations/AnnotatedClssWithExpandableComment.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classAnnotations" data-class-name="AnnotatedClssWithExpandableComment" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classAnnotations</a>
|
||||
<h1 id="declaration-title">AnnotatedClssWithExpandableComment<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_overview">Overview</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i>
|
||||
<div class="member-signature member-deprecated">class <span class="name-decl">AnnotatedClssWithExpandableComment</span></div>
|
||||
<div class="doc-comment">Deprecated: Spelling mistake. Replace with: <code>AnnotatedClass</code></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
<dt>Also known as:</dt>
|
||||
<dd><code>OtherName</code></dd>
|
||||
</dl>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This <code>AnnotatedClssWithExpandableComment</code> thought to have a correctly spelled name.</p><p>Unfortunately, it did not, as we explain in this expandable comment.</p></div>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="AnnotatedClssWithExpandableComment.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="AnnotatedClssWithExpandableComment.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
238
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classAnnotations/index.html
vendored
Normal file
238
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classAnnotations/index.html
vendored
Normal file
@@ -0,0 +1,238 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>classAnnotations (com.package1:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classAnnotations/index.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classAnnotations" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a>
|
||||
<h1 id="declaration-title">com.package1.classAnnotations<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
<li><a href="#_classes">Classes</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">open module <span class="name-decl">com.package1.classAnnotations</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="">Module URI:</dt>
|
||||
<dd><span class="import-uri">https://pkl.io/classAnnotations.pkl</span><i class="copy-uri-button material-icons">content_copy</i></dd>
|
||||
<dt class="">Source code:</dt>
|
||||
<dd><a href="https://example.com/package1/classAnnotations.pkl">classAnnotations.pkl</a></dd>
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="output" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#output">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">output</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/ModuleOutput.html" class="name-ref">ModuleOutput</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The output of this module.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Defaults to all module properties rendered as either Pcf or the format specified on the command line.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="relativePathTo()" class="anchor"> </div>
|
||||
<div id="relativePathTo().other" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#relativePathTo()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">relativePathTo</span>(<span class="param1">other</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Module.html" class="name-ref">Module</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the relative, descendent directory path between this module and <code>other</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if no such path exists.</p>
|
||||
<p>For example, if module <code>mod1</code> has path <code>/dir1/mod1.pkl</code>, and module <code>mod2</code> has path <code>/dir1/dir2/dir3/mod2.pkl</code>,
|
||||
then <code>mod1.relativePathTo(mod2)</code> will return <code>List("dir2", "dir3")</code>.</p>
|
||||
<p>A common use case is to compute the directory path between a template located at the root of a hierarchy
|
||||
(say <code>rootModule.pkl</code>) and the currently evaluated module (accessible via the <code>module</code> keyword):</p>
|
||||
<pre><code>import "rootModule.pkl" // self-import
|
||||
path = rootModule.relativePathTo(module)
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_classes" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Classes</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="AnnotatedClss" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#AnnotatedClss">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers member-deprecated">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature member-deprecated"><a href="AnnotatedClss.html" class="name-decl">AnnotatedClss</a><a class="member-source-link" href="https://example.com/package1/classAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment">Deprecated: Spelling mistake. Replace with: <code>AnnotatedClass</code></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="AnnotatedClssWithExpandableComment" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#AnnotatedClssWithExpandableComment">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers member-deprecated">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature member-deprecated"><a href="AnnotatedClssWithExpandableComment.html" class="name-decl">AnnotatedClssWithExpandableComment</a><a class="member-source-link" href="https://example.com/package1/classAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment">Deprecated: Spelling mistake. Replace with: <code>AnnotatedClass</code></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="AnnotatedClass" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#AnnotatedClass">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers member-deprecated">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature member-deprecated"><a href="AnnotatedClass.html" class="name-decl">AnnotatedClass</a><a class="member-source-link" href="https://example.com/package1/classAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment">Deprecated.</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
150
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments1.html
vendored
Normal file
150
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments1.html
vendored
Normal file
@@ -0,0 +1,150 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Comments1 (com.package1/classComments:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classComments/Comments1.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classComments" data-class-name="Comments1" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classComments</a>
|
||||
<h1 id="declaration-title">Comments1<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">Comments1</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Comments1.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Comments1.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
150
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments2.html
vendored
Normal file
150
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments2.html
vendored
Normal file
@@ -0,0 +1,150 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Comments2 (com.package1/classComments:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classComments/Comments2.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classComments" data-class-name="Comments2" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classComments</a>
|
||||
<h1 id="declaration-title">Comments2<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">Comments2</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Comments2.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Comments2.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
151
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments3.html
vendored
Normal file
151
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments3.html
vendored
Normal file
@@ -0,0 +1,151 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Comments3 (com.package1/classComments:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classComments/Comments3.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classComments" data-class-name="Comments3" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classComments</a>
|
||||
<h1 id="declaration-title">Comments3<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">Comments3</span></div>
|
||||
<div class="doc-comment"><p>Class with single-line doc comment.</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Comments3.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Comments3.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
155
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments4.html
vendored
Normal file
155
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments4.html
vendored
Normal file
@@ -0,0 +1,155 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Comments4 (com.package1/classComments:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classComments/Comments4.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classComments" data-class-name="Comments4" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classComments</a>
|
||||
<h1 id="declaration-title">Comments4<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_overview">Overview</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i>
|
||||
<div class="member-signature">class <span class="name-decl">Comments4</span></div>
|
||||
<div class="doc-comment"><p>Class with multi-line and multi-paragraph doc comment (paragraph1, line1).
|
||||
Class with multi-line and multi-paragraph doc comment (paragraph1, line2).</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Class with multi-line and multi-paragraph doc comment (paragraph2, line1).
|
||||
Class with multi-line and multi-paragraph doc comment (paragraph2, line2).</p></div>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Comments4.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Comments4.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
151
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments5.html
vendored
Normal file
151
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments5.html
vendored
Normal file
@@ -0,0 +1,151 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Comments5 (com.package1/classComments:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classComments/Comments5.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classComments" data-class-name="Comments5" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classComments</a>
|
||||
<h1 id="declaration-title">Comments5<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">Comments5</span></div>
|
||||
<div class="doc-comment"><p>Class with <a href="https://apple.com">single-line</a> <em>Markdown</em> doc comment.</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Comments5.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Comments5.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
153
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments6.html
vendored
Normal file
153
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments6.html
vendored
Normal file
@@ -0,0 +1,153 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Comments6 (com.package1/classComments:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classComments/Comments6.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classComments" data-class-name="Comments6" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classComments</a>
|
||||
<h1 id="declaration-title">Comments6<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">Comments6</span></div>
|
||||
<div class="doc-comment"><p>Class with
|
||||
<a href="https://apple.com">multi-line</a>
|
||||
<em>Markdown</em> doc comment.</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Comments6.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Comments6.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
151
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments7.html
vendored
Normal file
151
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments7.html
vendored
Normal file
@@ -0,0 +1,151 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Comments7 (com.package1/classComments:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classComments/Comments7.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classComments" data-class-name="Comments7" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classComments</a>
|
||||
<h1 id="declaration-title">Comments7<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">Comments7</span></div>
|
||||
<div class="doc-comment"><p>😀😀😀 Class with 😎😎😎 Unicode doc comment. 😡😡😡</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Comments7.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Comments7.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
202
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments8.html
vendored
Normal file
202
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/Comments8.html
vendored
Normal file
@@ -0,0 +1,202 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Comments8 (com.package1/classComments:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classComments/Comments8.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classComments" data-class-name="Comments8" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classComments</a>
|
||||
<h1 id="declaration-title">Comments8<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_overview">Overview</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i>
|
||||
<div class="member-signature">class <span class="name-decl">Comments8</span></div>
|
||||
<div class="doc-comment"><p>The greatest breakthrough since ever.</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
<div class="doc-comment expandable hidden collapsed"><h2>Installation</h2>
|
||||
<p>Just follow these simple steps:</p>
|
||||
<ol>
|
||||
<li>Install it
|
||||
<ol>
|
||||
<li>I promise it's easy.</li>
|
||||
<li>You'll figure it out.</li>
|
||||
</ol>
|
||||
</li>
|
||||
<li>Install it
|
||||
<pre><code>name = "Pigeon"
|
||||
age = 42
|
||||
</code></pre>
|
||||
</li>
|
||||
<li>Install it</li>
|
||||
</ol>
|
||||
<p>Let me <strong>emphasize</strong> how <em>simple</em> this is.</p>
|
||||
<p>😀😀😀 emoji day 😎😎😎 don't get 😡😡😡</p>
|
||||
<h2>Code</h2>
|
||||
<p>The code is beautiful:</p>
|
||||
<pre><code>/// example module
|
||||
module foo.bar
|
||||
|
||||
person {
|
||||
name = "Pigeon"
|
||||
age = 42
|
||||
}
|
||||
|
||||
function sing() = "tra-la-la"
|
||||
|
||||
class Person {
|
||||
name: String
|
||||
age: Int
|
||||
}
|
||||
</code></pre>
|
||||
<h2>Random Tips</h2>
|
||||
<ul>
|
||||
<li>don't give up
|
||||
<ul>
|
||||
<li>just don't</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>don't give up</li>
|
||||
</ul>
|
||||
<h1>Level 1</h1>
|
||||
<h2>Level 2</h2>
|
||||
<h3>Level 3</h3>
|
||||
<h4>Level 4</h4>
|
||||
<h5>Level 5</h5>
|
||||
<h6>Level 6</h6></div>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Comments8.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Comments8.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
369
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/index.html
vendored
Normal file
369
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/index.html
vendored
Normal file
@@ -0,0 +1,369 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>classComments (com.package1:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classComments/index.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classComments" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a>
|
||||
<h1 id="declaration-title">com.package1.classComments<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_overview">Overview</a></li>
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
<li><a href="#_classes">Classes</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i>
|
||||
<div class="member-signature">open module <span class="name-decl">com.package1.classComments</span></div>
|
||||
<div class="doc-comment"><p>The greatest breakthrough since ever.</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="">Module URI:</dt>
|
||||
<dd><span class="import-uri">https://pkl.io/classComments.pkl</span><i class="copy-uri-button material-icons">content_copy</i></dd>
|
||||
<dt class="">Source code:</dt>
|
||||
<dd><a href="https://example.com/package1/classComments.pkl">classComments.pkl</a></dd>
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
<div class="doc-comment expandable hidden collapsed"><h3>Installation</h3>
|
||||
<p>Just follow these simple steps:</p>
|
||||
<ol>
|
||||
<li>Install it
|
||||
<ol>
|
||||
<li>I promise it's easy.</li>
|
||||
<li>You'll figure it out.</li>
|
||||
</ol>
|
||||
</li>
|
||||
<li>Install it
|
||||
<pre><code>name = "Pigeon"
|
||||
age = 42
|
||||
</code></pre>
|
||||
</li>
|
||||
<li>Install it</li>
|
||||
</ol>
|
||||
<p>Let me <strong>emphasize</strong> how <em>simple</em> this is.</p>
|
||||
<p>😀😀😀 emoji day 😎😎😎 don't get 😡😡😡</p>
|
||||
<h3>Code</h3>
|
||||
<p>The code is beautiful:</p>
|
||||
<pre><code>/// example module
|
||||
module foo.bar
|
||||
|
||||
person {
|
||||
name = "Pigeon"
|
||||
age = 42
|
||||
}
|
||||
|
||||
function sing() = "tra-la-la"
|
||||
|
||||
class Person {
|
||||
name: String
|
||||
age: Int
|
||||
}
|
||||
</code></pre>
|
||||
<h3>Random Tips</h3>
|
||||
<ul>
|
||||
<li>don't give up
|
||||
<ul>
|
||||
<li>just don't</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>don't give up</li>
|
||||
</ul>
|
||||
<h1>Level 1</h1>
|
||||
<h2>Level 2</h2>
|
||||
<h3>Level 3</h3>
|
||||
<h4>Level 4</h4>
|
||||
<h5>Level 5</h5>
|
||||
<h6>Level 6</h6>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Command</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>git status</code></td>
|
||||
<td>List all <em>new or modified</em> files</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>git diff</code></td>
|
||||
<td>Show file differences that <strong>haven't been</strong> staged</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="output" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#output">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">output</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/ModuleOutput.html" class="name-ref">ModuleOutput</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The output of this module.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Defaults to all module properties rendered as either Pcf or the format specified on the command line.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="relativePathTo()" class="anchor"> </div>
|
||||
<div id="relativePathTo().other" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#relativePathTo()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">relativePathTo</span>(<span class="param1">other</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Module.html" class="name-ref">Module</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the relative, descendent directory path between this module and <code>other</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if no such path exists.</p>
|
||||
<p>For example, if module <code>mod1</code> has path <code>/dir1/mod1.pkl</code>, and module <code>mod2</code> has path <code>/dir1/dir2/dir3/mod2.pkl</code>,
|
||||
then <code>mod1.relativePathTo(mod2)</code> will return <code>List("dir2", "dir3")</code>.</p>
|
||||
<p>A common use case is to compute the directory path between a template located at the root of a hierarchy
|
||||
(say <code>rootModule.pkl</code>) and the currently evaluated module (accessible via the <code>module</code> keyword):</p>
|
||||
<pre><code>import "rootModule.pkl" // self-import
|
||||
path = rootModule.relativePathTo(module)
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_classes" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Classes</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="Comments1" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Comments1">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Comments1.html" class="name-decl">Comments1</a><a class="member-source-link" href="https://example.com/package1/classComments.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="Comments2" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Comments2">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Comments2.html" class="name-decl">Comments2</a><a class="member-source-link" href="https://example.com/package1/classComments.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="Comments3" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Comments3">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Comments3.html" class="name-decl">Comments3</a><a class="member-source-link" href="https://example.com/package1/classComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Class with single-line doc comment.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="Comments4" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Comments4">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Comments4.html" class="name-decl">Comments4</a><a class="member-source-link" href="https://example.com/package1/classComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Class with multi-line and multi-paragraph doc comment (paragraph1, line1).
|
||||
Class with multi-line and multi-paragraph doc comment (paragraph1, line2).</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="Comments5" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Comments5">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Comments5.html" class="name-decl">Comments5</a><a class="member-source-link" href="https://example.com/package1/classComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Class with <a href="https://apple.com">single-line</a> <em>Markdown</em> doc comment.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="Comments6" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Comments6">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Comments6.html" class="name-decl">Comments6</a><a class="member-source-link" href="https://example.com/package1/classComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Class with
|
||||
<a href="https://apple.com">multi-line</a>
|
||||
<em>Markdown</em> doc comment.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="Comments7" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Comments7">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Comments7.html" class="name-decl">Comments7</a><a class="member-source-link" href="https://example.com/package1/classComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>😀😀😀 Class with 😎😎😎 Unicode doc comment. 😡😡😡</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="Comments8" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Comments8">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Comments8.html" class="name-decl">Comments8</a><a class="member-source-link" href="https://example.com/package1/classComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The greatest breakthrough since ever.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
182
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/MyClass1.html
vendored
Normal file
182
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/MyClass1.html
vendored
Normal file
@@ -0,0 +1,182 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>MyClass1 (com.package1/classInheritance:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classInheritance/MyClass1.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classInheritance" data-class-name="MyClass1" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classInheritance</a>
|
||||
<h1 id="declaration-title">MyClass1<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">abstract class <span class="name-decl">MyClass1</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="property1" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property1">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">abstract </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property1</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Inherited property comment.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="MyClass1.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="MyClass1.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method1()" class="anchor"> </div>
|
||||
<div id="method1().arg" class="anchor-param1"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method1()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">abstract function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method1</span>(<span class="param1">arg</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>function method1 in class MyClass1.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
205
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/MyClass2.html
vendored
Normal file
205
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/MyClass2.html
vendored
Normal file
@@ -0,0 +1,205 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>MyClass2 (com.package1/classInheritance:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classInheritance/MyClass2.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classInheritance" data-class-name="MyClass2" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classInheritance</a>
|
||||
<h1 id="declaration-title">MyClass2<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">open class <span class="name-decl">MyClass2</span> extends <a href="MyClass1.html" class="name-ref">MyClass1</a></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="property1" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property1">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property1</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Inherited property comment.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property2" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property2">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property2</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="MyClass2.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="MyClass2.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method1()" class="anchor"> </div>
|
||||
<div id="method1().arg" class="anchor-param1"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method1()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method1</span>(<span class="param1">arg</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>function method1 in class MyClass2.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method2()" class="anchor"> </div>
|
||||
<div id="method2().arg" class="anchor-param1"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method2()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method2</span>(<span class="param1">arg</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
205
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/MyClass3.html
vendored
Normal file
205
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/MyClass3.html
vendored
Normal file
@@ -0,0 +1,205 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>MyClass3 (com.package1/classInheritance:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classInheritance/MyClass3.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classInheritance" data-class-name="MyClass3" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classInheritance</a>
|
||||
<h1 id="declaration-title">MyClass3<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">abstract class <span class="name-decl">MyClass3</span> extends <a href="MyClass2.html" class="name-ref">MyClass2</a></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="property1" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property1">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property1</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Inherited property comment.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property2" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#property2">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="MyClass2.html" class="name-ref">MyClass2</a>.</span><span class="name-decl">property2</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="index.html" class="name-ref">com.package1.classInheritance</a>)</span><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="MyClass3.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="MyClass3.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method1()" class="anchor"> </div>
|
||||
<div id="method1().arg" class="anchor-param1"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method1()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method1</span>(<span class="param1">arg</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>function method1 in class MyClass2.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method2()" class="anchor"> </div>
|
||||
<div id="method2().arg" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#method2()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="MyClass2.html" class="name-ref">MyClass2</a>.</span><span class="name-decl">method2</span>(<span class="param1">arg</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="index.html" class="name-ref">com.package1.classInheritance</a>)</span><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
228
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/MyClass4.html
vendored
Normal file
228
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/MyClass4.html
vendored
Normal file
@@ -0,0 +1,228 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>MyClass4 (com.package1/classInheritance:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classInheritance/MyClass4.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classInheritance" data-class-name="MyClass4" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classInheritance</a>
|
||||
<h1 id="declaration-title">MyClass4<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">MyClass4</span> extends <a href="MyClass2.html" class="name-ref">MyClass2</a></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="property1" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#property1">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="MyClass2.html" class="name-ref">MyClass2</a>.</span><span class="name-decl">property1</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="index.html" class="name-ref">com.package1.classInheritance</a>)</span><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Inherited property comment.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property2" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#property2">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="MyClass2.html" class="name-ref">MyClass2</a>.</span><span class="name-decl">property2</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="index.html" class="name-ref">com.package1.classInheritance</a>)</span><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property4" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property4">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property4</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="MyClass4.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="MyClass4.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method1()" class="anchor"> </div>
|
||||
<div id="method1().arg" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#method1()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="MyClass2.html" class="name-ref">MyClass2</a>.</span><span class="name-decl">method1</span>(<span class="param1">arg</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="index.html" class="name-ref">com.package1.classInheritance</a>)</span><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>function method1 in class MyClass2.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method2()" class="anchor"> </div>
|
||||
<div id="method2().arg" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#method2()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="MyClass2.html" class="name-ref">MyClass2</a>.</span><span class="name-decl">method2</span>(<span class="param1">arg</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="index.html" class="name-ref">com.package1.classInheritance</a>)</span><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method3()" class="anchor"> </div>
|
||||
<div id="method3().arg" class="anchor-param1"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method3()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method3</span>(<span class="param1">arg</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
247
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/index.html
vendored
Normal file
247
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/index.html
vendored
Normal file
@@ -0,0 +1,247 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>classInheritance (com.package1:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classInheritance/index.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classInheritance" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a>
|
||||
<h1 id="declaration-title">com.package1.classInheritance<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
<li><a href="#_classes">Classes</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">module <span class="name-decl">com.package1.classInheritance</span></div>
|
||||
<div class="doc-comment"><p>Class inheritance involving abstract, open, and final classes.</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="">Module URI:</dt>
|
||||
<dd><span class="import-uri">https://pkl.io/classInheritance.pkl</span><i class="copy-uri-button material-icons">content_copy</i></dd>
|
||||
<dt class="">Source code:</dt>
|
||||
<dd><a href="https://example.com/package1/classInheritance.pkl">classInheritance.pkl</a></dd>
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="output" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#output">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">output</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/ModuleOutput.html" class="name-ref">ModuleOutput</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The output of this module.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Defaults to all module properties rendered as either Pcf or the format specified on the command line.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="relativePathTo()" class="anchor"> </div>
|
||||
<div id="relativePathTo().other" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#relativePathTo()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">relativePathTo</span>(<span class="param1">other</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Module.html" class="name-ref">Module</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the relative, descendent directory path between this module and <code>other</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if no such path exists.</p>
|
||||
<p>For example, if module <code>mod1</code> has path <code>/dir1/mod1.pkl</code>, and module <code>mod2</code> has path <code>/dir1/dir2/dir3/mod2.pkl</code>,
|
||||
then <code>mod1.relativePathTo(mod2)</code> will return <code>List("dir2", "dir3")</code>.</p>
|
||||
<p>A common use case is to compute the directory path between a template located at the root of a hierarchy
|
||||
(say <code>rootModule.pkl</code>) and the currently evaluated module (accessible via the <code>module</code> keyword):</p>
|
||||
<pre><code>import "rootModule.pkl" // self-import
|
||||
path = rootModule.relativePathTo(module)
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_classes" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Classes</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="MyClass1" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#MyClass1">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">abstract class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="MyClass1.html" class="name-decl">MyClass1</a><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="MyClass2" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#MyClass2">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">open class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="MyClass2.html" class="name-decl">MyClass2</a> extends <a href="MyClass1.html" class="name-ref">MyClass1</a><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="MyClass3" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#MyClass3">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">abstract class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="MyClass3.html" class="name-decl">MyClass3</a> extends <a href="MyClass2.html" class="name-ref">MyClass2</a><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="MyClass4" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#MyClass4">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="MyClass4.html" class="name-decl">MyClass4</a> extends <a href="MyClass2.html" class="name-ref">MyClass2</a><a class="member-source-link" href="https://example.com/package1/classInheritance.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
236
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodComments/Comments.html
vendored
Normal file
236
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodComments/Comments.html
vendored
Normal file
@@ -0,0 +1,236 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Comments (com.package1/classMethodComments:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classMethodComments/Comments.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classMethodComments" data-class-name="Comments" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classMethodComments</a>
|
||||
<h1 id="declaration-title">Comments<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">Comments</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Comments.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Comments.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method1()" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method1()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method1</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classMethodComments.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method2()" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method2()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method2</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classMethodComments.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method3()" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method3()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method3</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classMethodComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Method with single-line doc comment.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method4()" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method4()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method4</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classMethodComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Method with
|
||||
multi-line
|
||||
doc comment.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method5()" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method5()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method5</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classMethodComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Method with <a href="https://apple.com">single-line</a> <em>Markdown</em> doc comment.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method6()" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method6()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method6</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classMethodComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Method with
|
||||
<a href="https://apple.com">multi-line</a>
|
||||
<em>Markdown</em> doc comment.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method7()" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method7()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method7</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classMethodComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>😀😀😀 Method with 😎😎😎 Unicode doc comment. 😡😡😡</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
214
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodComments/index.html
vendored
Normal file
214
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodComments/index.html
vendored
Normal file
@@ -0,0 +1,214 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>classMethodComments (com.package1:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classMethodComments/index.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classMethodComments" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a>
|
||||
<h1 id="declaration-title">com.package1.classMethodComments<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
<li><a href="#_classes">Classes</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">module <span class="name-decl">com.package1.classMethodComments</span></div>
|
||||
<div class="doc-comment"><p>Class methods with different kinds of comments.</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="">Module URI:</dt>
|
||||
<dd><span class="import-uri">https://pkl.io/classMethodComments.pkl</span><i class="copy-uri-button material-icons">content_copy</i></dd>
|
||||
<dt class="">Source code:</dt>
|
||||
<dd><a href="https://example.com/package1/classMethodComments.pkl">classMethodComments.pkl</a></dd>
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="output" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#output">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">output</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/ModuleOutput.html" class="name-ref">ModuleOutput</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The output of this module.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Defaults to all module properties rendered as either Pcf or the format specified on the command line.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="relativePathTo()" class="anchor"> </div>
|
||||
<div id="relativePathTo().other" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#relativePathTo()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">relativePathTo</span>(<span class="param1">other</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Module.html" class="name-ref">Module</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the relative, descendent directory path between this module and <code>other</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if no such path exists.</p>
|
||||
<p>For example, if module <code>mod1</code> has path <code>/dir1/mod1.pkl</code>, and module <code>mod2</code> has path <code>/dir1/dir2/dir3/mod2.pkl</code>,
|
||||
then <code>mod1.relativePathTo(mod2)</code> will return <code>List("dir2", "dir3")</code>.</p>
|
||||
<p>A common use case is to compute the directory path between a template located at the root of a hierarchy
|
||||
(say <code>rootModule.pkl</code>) and the currently evaluated module (accessible via the <code>module</code> keyword):</p>
|
||||
<pre><code>import "rootModule.pkl" // self-import
|
||||
path = rootModule.relativePathTo(module)
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_classes" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Classes</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="Comments" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Comments">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Comments.html" class="name-decl">Comments</a><a class="member-source-link" href="https://example.com/package1/classMethodComments.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,163 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Modifiers (com.package1/classMethodModifiers:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classMethodModifiers/Modifiers.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classMethodModifiers" data-class-name="Modifiers" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classMethodModifiers</a>
|
||||
<h1 id="declaration-title">Modifiers<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">abstract class <span class="name-decl">Modifiers</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Modifiers.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Modifiers.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method1()" class="anchor"> </div>
|
||||
<div id="method1().arg" class="anchor-param1"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method1()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">abstract function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method1</span>(<span class="param1">arg</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><a class="member-source-link" href="https://example.com/package1/classMethodModifiers.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Method with <code>abstract</code> modifier.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
214
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodModifiers/index.html
vendored
Normal file
214
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodModifiers/index.html
vendored
Normal file
@@ -0,0 +1,214 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>classMethodModifiers (com.package1:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classMethodModifiers/index.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classMethodModifiers" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a>
|
||||
<h1 id="declaration-title">com.package1.classMethodModifiers<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
<li><a href="#_classes">Classes</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">module <span class="name-decl">com.package1.classMethodModifiers</span></div>
|
||||
<div class="doc-comment"><p>Class methods with different modifiers.</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="">Module URI:</dt>
|
||||
<dd><span class="import-uri">https://pkl.io/classMethodModifiers.pkl</span><i class="copy-uri-button material-icons">content_copy</i></dd>
|
||||
<dt class="">Source code:</dt>
|
||||
<dd><a href="https://example.com/package1/classMethodModifiers.pkl">classMethodModifiers.pkl</a></dd>
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="output" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#output">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">output</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/ModuleOutput.html" class="name-ref">ModuleOutput</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The output of this module.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Defaults to all module properties rendered as either Pcf or the format specified on the command line.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="relativePathTo()" class="anchor"> </div>
|
||||
<div id="relativePathTo().other" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#relativePathTo()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">relativePathTo</span>(<span class="param1">other</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Module.html" class="name-ref">Module</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the relative, descendent directory path between this module and <code>other</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if no such path exists.</p>
|
||||
<p>For example, if module <code>mod1</code> has path <code>/dir1/mod1.pkl</code>, and module <code>mod2</code> has path <code>/dir1/dir2/dir3/mod2.pkl</code>,
|
||||
then <code>mod1.relativePathTo(mod2)</code> will return <code>List("dir2", "dir3")</code>.</p>
|
||||
<p>A common use case is to compute the directory path between a template located at the root of a hierarchy
|
||||
(say <code>rootModule.pkl</code>) and the currently evaluated module (accessible via the <code>module</code> keyword):</p>
|
||||
<pre><code>import "rootModule.pkl" // self-import
|
||||
path = rootModule.relativePathTo(module)
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_classes" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Classes</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="Modifiers" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Modifiers">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">abstract class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Modifiers.html" class="name-decl">Modifiers</a><a class="member-source-link" href="https://example.com/package1/classMethodModifiers.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,325 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>TypeAnnotations (com.package1/classMethodTypeAnnotations:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classMethodTypeAnnotations/TypeAnnotations.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classMethodTypeAnnotations" data-class-name="TypeAnnotations" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classMethodTypeAnnotations</a>
|
||||
<h1 id="declaration-title">TypeAnnotations<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">TypeAnnotations</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="TypeAnnotations.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="TypeAnnotations.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method1()" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method1()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method1</span>(): unknown<a class="member-source-link" href="https://example.com/package1/classMethodTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Zero-arg method without declared types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method2()" class="anchor"> </div>
|
||||
<div id="method2().arg1" class="anchor-param1"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method2()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method2</span>(<span class="param1">arg1</span>: unknown): unknown<a class="member-source-link" href="https://example.com/package1/classMethodTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>One-arg method without declared types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method3()" class="anchor"> </div>
|
||||
<div id="method3().arg1" class="anchor-param1"> </div>
|
||||
<div id="method3().arg2" class="anchor-param2"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method3()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method3</span>(<span class="param1">arg1</span>: unknown, <span class="param2">arg2</span>: unknown): unknown<a class="member-source-link" href="https://example.com/package1/classMethodTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Two-arg method without declared types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method4()" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method4()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method4</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><a class="member-source-link" href="https://example.com/package1/classMethodTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Zero-arg method with simple types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method5()" class="anchor"> </div>
|
||||
<div id="method5().arg1" class="anchor-param1"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method5()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method5</span>(<span class="param1">arg1</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a><a class="member-source-link" href="https://example.com/package1/classMethodTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>One-arg method with simple types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method6()" class="anchor"> </div>
|
||||
<div id="method6().arg1" class="anchor-param1"> </div>
|
||||
<div id="method6().arg2" class="anchor-param2"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method6()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method6</span>(<span class="param1">arg1</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a>, <span class="param2">arg2</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Duration.html" class="name-ref">Duration</a><a class="member-source-link" href="https://example.com/package1/classMethodTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Two-arg method with simple types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method7()" class="anchor"> </div>
|
||||
<div id="method7().arg1" class="anchor-param1"> </div>
|
||||
<div id="method7().arg2" class="anchor-param2"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method7()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method7</span>(<span class="param1">arg1</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a>>, <span class="param2">arg2</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a>>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Duration.html" class="name-ref">Duration</a>><a class="member-source-link" href="https://example.com/package1/classMethodTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Two-arg method with list types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method8()" class="anchor"> </div>
|
||||
<div id="method8().arg1" class="anchor-param1"> </div>
|
||||
<div id="method8().arg2" class="anchor-param2"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method8()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method8</span>(<span class="param1">arg1</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Set.html" class="name-ref">Set</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a>>, <span class="param2">arg2</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Set.html" class="name-ref">Set</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a>>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Set.html" class="name-ref">Set</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Duration.html" class="name-ref">Duration</a>><a class="member-source-link" href="https://example.com/package1/classMethodTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Two-arg method with set types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method9()" class="anchor"> </div>
|
||||
<div id="method9().arg1" class="anchor-param1"> </div>
|
||||
<div id="method9().arg2" class="anchor-param2"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method9()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method9</span>(<span class="param1">arg1</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a>, <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a>>, <span class="param2">arg2</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a>, <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a>>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Duration.html" class="name-ref">Duration</a>, <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Duration.html" class="name-ref">Duration</a>><a class="member-source-link" href="https://example.com/package1/classMethodTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Two-arg method with map types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method10()" class="anchor"> </div>
|
||||
<div id="method10().arg1" class="anchor-param1"> </div>
|
||||
<div id="method10().arg2" class="anchor-param2"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method10()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method10</span>(<span class="param1">arg1</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a>?, <span class="param2">arg2</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a>?): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Duration.html" class="name-ref">Duration</a>?<a class="member-source-link" href="https://example.com/package1/classMethodTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Two-arg method with optional types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method11()" class="anchor"> </div>
|
||||
<div id="method11().arg1" class="anchor-param1"> </div>
|
||||
<div id="method11().arg2" class="anchor-param2"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method11()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method11</span>(<span class="param1">arg1</span>: () -> <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a>, <span class="param2">arg2</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a>) -> <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a>): (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a>, <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a>) -> <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Duration.html" class="name-ref">Duration</a><a class="member-source-link" href="https://example.com/package1/classMethodTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Two-arg method with function types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method12()" class="anchor"> </div>
|
||||
<div id="method12().arg1" class="anchor-param1"> </div>
|
||||
<div id="method12().arg2" class="anchor-param2"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method12()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method12</span>(<span class="param1">arg1</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, <span class="param2">arg2</span>: unknown): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><a class="member-source-link" href="https://example.com/package1/classMethodTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Two-arg method with partially declared types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method13()" class="anchor"> </div>
|
||||
<div id="method13().arg1" class="anchor-param1"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method13()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method13</span>(<span class="param1">arg1</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>?>?, (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a>?) -> <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a>, <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a>>>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Duration.html" class="name-ref">Duration</a>?>?, (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/DataSize.html" class="name-ref">DataSize</a>?) -> <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>, <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Number.html" class="name-ref">Number</a>>><a class="member-source-link" href="https://example.com/package1/classMethodTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>One-arg method with complex types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,214 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>classMethodTypeAnnotations (com.package1:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classMethodTypeAnnotations/index.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classMethodTypeAnnotations" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a>
|
||||
<h1 id="declaration-title">com.package1.classMethodTypeAnnotations<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
<li><a href="#_classes">Classes</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">module <span class="name-decl">com.package1.classMethodTypeAnnotations</span></div>
|
||||
<div class="doc-comment"><p>Class methods with different kinds of type annotations.</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="">Module URI:</dt>
|
||||
<dd><span class="import-uri">https://pkl.io/classMethodTypeAnnotations.pkl</span><i class="copy-uri-button material-icons">content_copy</i></dd>
|
||||
<dt class="">Source code:</dt>
|
||||
<dd><a href="https://example.com/package1/classMethodTypeAnnotations.pkl">classMethodTypeAnnotations.pkl</a></dd>
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="output" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#output">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">output</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/ModuleOutput.html" class="name-ref">ModuleOutput</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The output of this module.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Defaults to all module properties rendered as either Pcf or the format specified on the command line.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="relativePathTo()" class="anchor"> </div>
|
||||
<div id="relativePathTo().other" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#relativePathTo()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">relativePathTo</span>(<span class="param1">other</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Module.html" class="name-ref">Module</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the relative, descendent directory path between this module and <code>other</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if no such path exists.</p>
|
||||
<p>For example, if module <code>mod1</code> has path <code>/dir1/mod1.pkl</code>, and module <code>mod2</code> has path <code>/dir1/dir2/dir3/mod2.pkl</code>,
|
||||
then <code>mod1.relativePathTo(mod2)</code> will return <code>List("dir2", "dir3")</code>.</p>
|
||||
<p>A common use case is to compute the directory path between a template located at the root of a hierarchy
|
||||
(say <code>rootModule.pkl</code>) and the currently evaluated module (accessible via the <code>module</code> keyword):</p>
|
||||
<pre><code>import "rootModule.pkl" // self-import
|
||||
path = rootModule.relativePathTo(module)
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_classes" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Classes</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="TypeAnnotations" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#TypeAnnotations">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="TypeAnnotations.html" class="name-decl">TypeAnnotations</a><a class="member-source-link" href="https://example.com/package1/classMethodTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,150 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>MyClass (com.package1/classMethodTypeReferences:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classMethodTypeReferences/MyClass.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classMethodTypeReferences" data-class-name="MyClass" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classMethodTypeReferences</a>
|
||||
<h1 id="declaration-title">MyClass<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">MyClass</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="MyClass.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="MyClass.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,220 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>TypeReferences (com.package1/classMethodTypeReferences:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classMethodTypeReferences/TypeReferences.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classMethodTypeReferences" data-class-name="TypeReferences" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classMethodTypeReferences</a>
|
||||
<h1 id="declaration-title">TypeReferences<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">TypeReferences</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="TypeReferences.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="TypeReferences.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method1()" class="anchor"> </div>
|
||||
<div id="method1().arg1" class="anchor-param1"> </div>
|
||||
<div id="method1().arg2" class="anchor-param2"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method1()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method1</span>(<span class="param1">arg1</span>: <a href="MyClass.html" class="name-ref">MyClass</a>, <span class="param2">arg2</span>: <a href="MyClass.html" class="name-ref">MyClass</a>): <a href="MyClass.html" class="name-ref">MyClass</a><a class="member-source-link" href="https://example.com/package1/classMethodTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Method with intra-module types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method2()" class="anchor"> </div>
|
||||
<div id="method2().arg1" class="anchor-param1"> </div>
|
||||
<div id="method2().arg2" class="anchor-param2"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method2()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method2</span>(<span class="param1">arg1</span>: <a href="../shared/MyClass.html" class="name-ref">MyClass</a>, <span class="param2">arg2</span>: <a href="../shared/MyClass.html" class="name-ref">MyClass</a>): <a href="../shared/MyClass.html" class="name-ref">MyClass</a><a class="member-source-link" href="https://example.com/package1/classMethodTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Method with inter-module types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method3()" class="anchor"> </div>
|
||||
<div id="method3().arg1" class="anchor-param1"> </div>
|
||||
<div id="method3().arg2" class="anchor-param2"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method3()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method3</span>(<span class="param1">arg1</span>: <a href="https://example.com/docs/externalpackage/external1/MyClass.html" class="name-ref">MyClass</a>, <span class="param2">arg2</span>: <a href="https://example.com/docs/externalpackage/external2/MyClass.html" class="name-ref">MyClass</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://example.com/docs/externalpackage/external1/MyClass.html" class="name-ref">MyClass</a>><a class="member-source-link" href="https://example.com/package1/classMethodTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Method with external-module types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method4()" class="anchor"> </div>
|
||||
<div id="method4().arg1" class="anchor-param1"> </div>
|
||||
<div id="method4().arg2" class="anchor-param2"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method4()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method4</span>(<span class="param1">arg1</span>: <a href="MyClass.html" class="name-ref">MyClass</a>, <span class="param2">arg2</span>: <a href="../shared/MyClass.html" class="name-ref">MyClass</a>): <a href="https://example.com/docs/externalpackage/external1/MyClass.html" class="name-ref">MyClass</a><a class="member-source-link" href="https://example.com/package1/classMethodTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Method with intra-module, inter-module, and external-module types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="method5()" class="anchor"> </div>
|
||||
<div id="method5().arg1" class="anchor-param1"> </div>
|
||||
<div id="method5().arg2" class="anchor-param2"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#method5()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">method5</span>(<span class="param1">arg1</span>: <a href="MyClass.html" class="name-ref">MyClass</a>?, <span class="param2">arg2</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="../shared/MyClass.html" class="name-ref">MyClass</a>, <a href="https://example.com/docs/externalpackage/external1/MyClass.html" class="name-ref">MyClass</a>>): (<a href="https://example.com/docs/externalpackage/external1/MyClass.html" class="name-ref">MyClass</a>) -> <a href="https://example.com/docs/externalpackage/external2/MyClass.html" class="name-ref">MyClass</a><a class="member-source-link" href="https://example.com/package1/classMethodTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Method with complex intra-module, inter-module, and external-module types.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,226 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>classMethodTypeReferences (com.package1:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classMethodTypeReferences/index.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classMethodTypeReferences" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a>
|
||||
<h1 id="declaration-title">com.package1.classMethodTypeReferences<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
<li><a href="#_classes">Classes</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">module <span class="name-decl">com.package1.classMethodTypeReferences</span></div>
|
||||
<div class="doc-comment"><p>Class methods whose types reference classes from
|
||||
the same module, a different module, and external modules.</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="">Module URI:</dt>
|
||||
<dd><span class="import-uri">https://pkl.io/classMethodTypeReferences.pkl</span><i class="copy-uri-button material-icons">content_copy</i></dd>
|
||||
<dt class="">Source code:</dt>
|
||||
<dd><a href="https://example.com/package1/classMethodTypeReferences.pkl">classMethodTypeReferences.pkl</a></dd>
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="output" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#output">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">output</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/ModuleOutput.html" class="name-ref">ModuleOutput</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The output of this module.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Defaults to all module properties rendered as either Pcf or the format specified on the command line.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="relativePathTo()" class="anchor"> </div>
|
||||
<div id="relativePathTo().other" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#relativePathTo()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">relativePathTo</span>(<span class="param1">other</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Module.html" class="name-ref">Module</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the relative, descendent directory path between this module and <code>other</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if no such path exists.</p>
|
||||
<p>For example, if module <code>mod1</code> has path <code>/dir1/mod1.pkl</code>, and module <code>mod2</code> has path <code>/dir1/dir2/dir3/mod2.pkl</code>,
|
||||
then <code>mod1.relativePathTo(mod2)</code> will return <code>List("dir2", "dir3")</code>.</p>
|
||||
<p>A common use case is to compute the directory path between a template located at the root of a hierarchy
|
||||
(say <code>rootModule.pkl</code>) and the currently evaluated module (accessible via the <code>module</code> keyword):</p>
|
||||
<pre><code>import "rootModule.pkl" // self-import
|
||||
path = rootModule.relativePathTo(module)
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_classes" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Classes</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="MyClass" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#MyClass">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="MyClass.html" class="name-decl">MyClass</a><a class="member-source-link" href="https://example.com/package1/classMethodTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="TypeReferences" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#TypeReferences">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="TypeReferences.html" class="name-decl">TypeReferences</a><a class="member-source-link" href="https://example.com/package1/classMethodTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,168 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>ClassWithAnnotatedProperty (com.package1/classPropertyAnnotations:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classPropertyAnnotations/ClassWithAnnotatedProperty.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classPropertyAnnotations" data-class-name="ClassWithAnnotatedProperty" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classPropertyAnnotations</a>
|
||||
<h1 id="declaration-title">ClassWithAnnotatedProperty<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">ClassWithAnnotatedProperty</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="propertyUserDefinedAnnotation" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#propertyUserDefinedAnnotation">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">propertyUserDefinedAnnotation</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a><a class="member-source-link" href="https://example.com/package1/classPropertyAnnotations.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="ClassWithAnnotatedProperty.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="ClassWithAnnotatedProperty.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,179 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>UserDefinedAnnotation (com.package1/classPropertyAnnotations:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classPropertyAnnotations/UserDefinedAnnotation.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classPropertyAnnotations" data-class-name="UserDefinedAnnotation" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classPropertyAnnotations</a>
|
||||
<h1 id="declaration-title">UserDefinedAnnotation<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">UserDefinedAnnotation</span> extends <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Annotation.html" class="name-ref">Annotation</a></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="messageOpt" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#messageOpt">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">messageOpt</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>?<a class="member-source-link" href="https://example.com/package1/classPropertyAnnotations.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="messageReq" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#messageReq">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">messageReq</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><a class="member-source-link" href="https://example.com/package1/classPropertyAnnotations.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="UserDefinedAnnotation.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="UserDefinedAnnotation.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,224 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>classPropertyAnnotations (com.package1:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classPropertyAnnotations/index.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classPropertyAnnotations" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a>
|
||||
<h1 id="declaration-title">com.package1.classPropertyAnnotations<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
<li><a href="#_classes">Classes</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">module <span class="name-decl">com.package1.classPropertyAnnotations</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="">Module URI:</dt>
|
||||
<dd><span class="import-uri">https://pkl.io/classPropertyAnnotations.pkl</span><i class="copy-uri-button material-icons">content_copy</i></dd>
|
||||
<dt class="">Source code:</dt>
|
||||
<dd><a href="https://example.com/package1/classPropertyAnnotations.pkl">classPropertyAnnotations.pkl</a></dd>
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="output" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#output">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">output</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/ModuleOutput.html" class="name-ref">ModuleOutput</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The output of this module.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Defaults to all module properties rendered as either Pcf or the format specified on the command line.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="relativePathTo()" class="anchor"> </div>
|
||||
<div id="relativePathTo().other" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#relativePathTo()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">relativePathTo</span>(<span class="param1">other</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Module.html" class="name-ref">Module</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the relative, descendent directory path between this module and <code>other</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if no such path exists.</p>
|
||||
<p>For example, if module <code>mod1</code> has path <code>/dir1/mod1.pkl</code>, and module <code>mod2</code> has path <code>/dir1/dir2/dir3/mod2.pkl</code>,
|
||||
then <code>mod1.relativePathTo(mod2)</code> will return <code>List("dir2", "dir3")</code>.</p>
|
||||
<p>A common use case is to compute the directory path between a template located at the root of a hierarchy
|
||||
(say <code>rootModule.pkl</code>) and the currently evaluated module (accessible via the <code>module</code> keyword):</p>
|
||||
<pre><code>import "rootModule.pkl" // self-import
|
||||
path = rootModule.relativePathTo(module)
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_classes" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Classes</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="UserDefinedAnnotation" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#UserDefinedAnnotation">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="UserDefinedAnnotation.html" class="name-decl">UserDefinedAnnotation</a> extends <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Annotation.html" class="name-ref">Annotation</a><a class="member-source-link" href="https://example.com/package1/classPropertyAnnotations.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ClassWithAnnotatedProperty" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#ClassWithAnnotatedProperty">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="ClassWithAnnotatedProperty.html" class="name-decl">ClassWithAnnotatedProperty</a><a class="member-source-link" href="https://example.com/package1/classPropertyAnnotations.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,243 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Comments (com.package1/classPropertyComments:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classPropertyComments/Comments.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classPropertyComments" data-class-name="Comments" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classPropertyComments</a>
|
||||
<h1 id="declaration-title">Comments<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">Comments</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="property1" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property1">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property1</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classPropertyComments.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property2" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property2">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property2</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classPropertyComments.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property3" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property3">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property3</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classPropertyComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with single-line doc comment.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property4" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property4">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property4</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classPropertyComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with
|
||||
multi-line
|
||||
doc comment.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property5" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property5">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property5</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classPropertyComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with <a href="https://apple.com">single-line</a> <em>Markdown</em> doc comment.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property6" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property6">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property6</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classPropertyComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with
|
||||
<a href="https://apple.com">multi-line</a>
|
||||
<em>Markdown</em> doc comment.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property7" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property7">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property7</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classPropertyComments.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>😀😀😀 Property with 😎😎😎 Unicode doc comment. 😡😡😡</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Comments.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Comments.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
214
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyComments/index.html
vendored
Normal file
214
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyComments/index.html
vendored
Normal file
@@ -0,0 +1,214 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>classPropertyComments (com.package1:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classPropertyComments/index.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classPropertyComments" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a>
|
||||
<h1 id="declaration-title">com.package1.classPropertyComments<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
<li><a href="#_classes">Classes</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">module <span class="name-decl">com.package1.classPropertyComments</span></div>
|
||||
<div class="doc-comment"><p>Class properties with different kinds of comments.</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="">Module URI:</dt>
|
||||
<dd><span class="import-uri">https://pkl.io/classPropertyComments.pkl</span><i class="copy-uri-button material-icons">content_copy</i></dd>
|
||||
<dt class="">Source code:</dt>
|
||||
<dd><a href="https://example.com/package1/classPropertyComments.pkl">classPropertyComments.pkl</a></dd>
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="output" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#output">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">output</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/ModuleOutput.html" class="name-ref">ModuleOutput</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The output of this module.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Defaults to all module properties rendered as either Pcf or the format specified on the command line.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="relativePathTo()" class="anchor"> </div>
|
||||
<div id="relativePathTo().other" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#relativePathTo()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">relativePathTo</span>(<span class="param1">other</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Module.html" class="name-ref">Module</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the relative, descendent directory path between this module and <code>other</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if no such path exists.</p>
|
||||
<p>For example, if module <code>mod1</code> has path <code>/dir1/mod1.pkl</code>, and module <code>mod2</code> has path <code>/dir1/dir2/dir3/mod2.pkl</code>,
|
||||
then <code>mod1.relativePathTo(mod2)</code> will return <code>List("dir2", "dir3")</code>.</p>
|
||||
<p>A common use case is to compute the directory path between a template located at the root of a hierarchy
|
||||
(say <code>rootModule.pkl</code>) and the currently evaluated module (accessible via the <code>module</code> keyword):</p>
|
||||
<pre><code>import "rootModule.pkl" // self-import
|
||||
path = rootModule.relativePathTo(module)
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_classes" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Classes</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="Comments" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Comments">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Comments.html" class="name-decl">Comments</a><a class="member-source-link" href="https://example.com/package1/classPropertyComments.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,193 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Modifiers (com.package1/classPropertyModifiers:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classPropertyModifiers/Modifiers.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classPropertyModifiers" data-class-name="Modifiers" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classPropertyModifiers</a>
|
||||
<h1 id="declaration-title">Modifiers<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">abstract class <span class="name-decl">Modifiers</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="property2" class="anchor"> </div>
|
||||
<div class="member hidden-member"><a class="member-selflink material-icons" href="#property2">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property2</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classPropertyModifiers.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with <code>hidden</code> modifier.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property3" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property3">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">abstract </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property3</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classPropertyModifiers.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with <code>abstract</code> modifier.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property4" class="anchor"> </div>
|
||||
<div class="member hidden-member"><a class="member-selflink material-icons" href="#property4">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">abstract hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property4</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classPropertyModifiers.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with multiple modifiers.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Modifiers.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Modifiers.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
214
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyModifiers/index.html
vendored
Normal file
214
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyModifiers/index.html
vendored
Normal file
@@ -0,0 +1,214 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>classPropertyModifiers (com.package1:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classPropertyModifiers/index.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classPropertyModifiers" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a>
|
||||
<h1 id="declaration-title">com.package1.classPropertyModifiers<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
<li><a href="#_classes">Classes</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">module <span class="name-decl">com.package1.classPropertyModifiers</span></div>
|
||||
<div class="doc-comment"><p>Class properties with different modifiers.</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="">Module URI:</dt>
|
||||
<dd><span class="import-uri">https://pkl.io/classPropertyModifiers.pkl</span><i class="copy-uri-button material-icons">content_copy</i></dd>
|
||||
<dt class="">Source code:</dt>
|
||||
<dd><a href="https://example.com/package1/classPropertyModifiers.pkl">classPropertyModifiers.pkl</a></dd>
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="output" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#output">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">output</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/ModuleOutput.html" class="name-ref">ModuleOutput</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The output of this module.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Defaults to all module properties rendered as either Pcf or the format specified on the command line.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="relativePathTo()" class="anchor"> </div>
|
||||
<div id="relativePathTo().other" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#relativePathTo()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">relativePathTo</span>(<span class="param1">other</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Module.html" class="name-ref">Module</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the relative, descendent directory path between this module and <code>other</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if no such path exists.</p>
|
||||
<p>For example, if module <code>mod1</code> has path <code>/dir1/mod1.pkl</code>, and module <code>mod2</code> has path <code>/dir1/dir2/dir3/mod2.pkl</code>,
|
||||
then <code>mod1.relativePathTo(mod2)</code> will return <code>List("dir2", "dir3")</code>.</p>
|
||||
<p>A common use case is to compute the directory path between a template located at the root of a hierarchy
|
||||
(say <code>rootModule.pkl</code>) and the currently evaluated module (accessible via the <code>module</code> keyword):</p>
|
||||
<pre><code>import "rootModule.pkl" // self-import
|
||||
path = rootModule.relativePathTo(module)
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_classes" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Classes</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="Modifiers" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Modifiers">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">abstract class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Modifiers.html" class="name-decl">Modifiers</a><a class="member-source-link" href="https://example.com/package1/classPropertyModifiers.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,277 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>TypeAnnotations (com.package1/classPropertyTypeAnnotations:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classPropertyTypeAnnotations/TypeAnnotations.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classPropertyTypeAnnotations" data-class-name="TypeAnnotations" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classPropertyTypeAnnotations</a>
|
||||
<h1 id="declaration-title">TypeAnnotations<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">TypeAnnotations</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="property1" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property1">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property1</span>: unknown<a class="member-source-link" href="https://example.com/package1/classPropertyTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property without declared type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property2" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property2">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property2</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a><a class="member-source-link" href="https://example.com/package1/classPropertyTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with simple type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property3" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property3">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property3</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><a class="member-source-link" href="https://example.com/package1/classPropertyTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with list type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property4" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property4">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property4</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Set.html" class="name-ref">Set</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><a class="member-source-link" href="https://example.com/package1/classPropertyTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with set type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property5" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property5">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property5</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Duration.html" class="name-ref">Duration</a>><a class="member-source-link" href="https://example.com/package1/classPropertyTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with map type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property6" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property6">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property6</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>?<a class="member-source-link" href="https://example.com/package1/classPropertyTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with optional type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property7" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property7">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property7</span>: () -> <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><a class="member-source-link" href="https://example.com/package1/classPropertyTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with zero-arg function type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property8" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property8">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property8</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>) -> <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a><a class="member-source-link" href="https://example.com/package1/classPropertyTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with one-arg function type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property9" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property9">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property9</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>) -> <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a><a class="member-source-link" href="https://example.com/package1/classPropertyTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with two-arg function type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property10" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property10">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property10</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>?>?, (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a>?) -> <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a>, <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Float.html" class="name-ref">Float</a>>><a class="member-source-link" href="https://example.com/package1/classPropertyTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with complex type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="TypeAnnotations.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="TypeAnnotations.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,214 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>classPropertyTypeAnnotations (com.package1:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classPropertyTypeAnnotations/index.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classPropertyTypeAnnotations" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a>
|
||||
<h1 id="declaration-title">com.package1.classPropertyTypeAnnotations<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
<li><a href="#_classes">Classes</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">module <span class="name-decl">com.package1.classPropertyTypeAnnotations</span></div>
|
||||
<div class="doc-comment"><p>Class properties with different kinds of type annotations.</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="">Module URI:</dt>
|
||||
<dd><span class="import-uri">https://pkl.io/classPropertyTypeAnnotations.pkl</span><i class="copy-uri-button material-icons">content_copy</i></dd>
|
||||
<dt class="">Source code:</dt>
|
||||
<dd><a href="https://example.com/package1/classPropertyTypeAnnotations.pkl">classPropertyTypeAnnotations.pkl</a></dd>
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="output" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#output">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">output</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/ModuleOutput.html" class="name-ref">ModuleOutput</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The output of this module.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Defaults to all module properties rendered as either Pcf or the format specified on the command line.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="relativePathTo()" class="anchor"> </div>
|
||||
<div id="relativePathTo().other" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#relativePathTo()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">relativePathTo</span>(<span class="param1">other</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Module.html" class="name-ref">Module</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the relative, descendent directory path between this module and <code>other</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if no such path exists.</p>
|
||||
<p>For example, if module <code>mod1</code> has path <code>/dir1/mod1.pkl</code>, and module <code>mod2</code> has path <code>/dir1/dir2/dir3/mod2.pkl</code>,
|
||||
then <code>mod1.relativePathTo(mod2)</code> will return <code>List("dir2", "dir3")</code>.</p>
|
||||
<p>A common use case is to compute the directory path between a template located at the root of a hierarchy
|
||||
(say <code>rootModule.pkl</code>) and the currently evaluated module (accessible via the <code>module</code> keyword):</p>
|
||||
<pre><code>import "rootModule.pkl" // self-import
|
||||
path = rootModule.relativePathTo(module)
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_classes" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Classes</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="TypeAnnotations" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#TypeAnnotations">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="TypeAnnotations.html" class="name-decl">TypeAnnotations</a><a class="member-source-link" href="https://example.com/package1/classPropertyTypeAnnotations.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,150 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>MyClass (com.package1/classPropertyTypeReferences:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classPropertyTypeReferences/MyClass.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classPropertyTypeReferences" data-class-name="MyClass" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classPropertyTypeReferences</a>
|
||||
<h1 id="declaration-title">MyClass<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">MyClass</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="MyClass.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="MyClass.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,265 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>TypeReferences (com.package1/classPropertyTypeReferences:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classPropertyTypeReferences/TypeReferences.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classPropertyTypeReferences" data-class-name="TypeReferences" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classPropertyTypeReferences</a>
|
||||
<h1 id="declaration-title">TypeReferences<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">TypeReferences</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="property1" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property1">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property1</span>: <a href="MyClass.html" class="name-ref">MyClass</a><a class="member-source-link" href="https://example.com/package1/classPropertyTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with intra-module simple type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property2" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property2">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property2</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="../shared/MyClass.html" class="name-ref">MyClass</a>><a class="member-source-link" href="https://example.com/package1/classPropertyTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with inter-module list type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property3" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property3">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property3</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Set.html" class="name-ref">Set</a><<a href="https://example.com/docs/externalpackage/external1/MyClass.html" class="name-ref">MyClass</a>><a class="member-source-link" href="https://example.com/package1/classPropertyTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with external-module set type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property4" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property4">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property4</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="MyClass.html" class="name-ref">MyClass</a>, <a href="../shared/MyClass.html" class="name-ref">MyClass</a>><a class="member-source-link" href="https://example.com/package1/classPropertyTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with intra-module and inter-module map type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property5" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property5">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property5</span>: <a href="https://example.com/docs/externalpackage/external1/MyClass.html" class="name-ref">MyClass</a>?<a class="member-source-link" href="https://example.com/package1/classPropertyTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with external-module optional type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property6" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property6">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property6</span>: () -> <a href="MyClass.html" class="name-ref">MyClass</a><a class="member-source-link" href="https://example.com/package1/classPropertyTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with zero-arg intra-module function type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property7" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property7">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property7</span>: (<a href="../shared/MyClass.html" class="name-ref">MyClass</a>) -> <a href="https://example.com/docs/externalpackage/external1/MyClass.html" class="name-ref">MyClass</a><a class="member-source-link" href="https://example.com/package1/classPropertyTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with one-arg inter-module and external-module function type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property8" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property8">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property8</span>: (<a href="MyClass.html" class="name-ref">MyClass</a>, <a href="../shared/MyClass.html" class="name-ref">MyClass</a>) -> <a href="https://example.com/docs/externalpackage/external1/MyClass.html" class="name-ref">MyClass</a><a class="member-source-link" href="https://example.com/package1/classPropertyTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with two-arg intra-module, inter-module, and external-module function type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="property9" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#property9">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">property9</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Mapping.html" class="name-ref">Mapping</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, <a href="MyClass.html" class="name-ref">MyClass</a>><a class="member-source-link" href="https://example.com/package1/classPropertyTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Property with intra-module mapping type.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="TypeReferences.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="TypeReferences.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,226 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>classPropertyTypeReferences (com.package1:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classPropertyTypeReferences/index.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classPropertyTypeReferences" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a>
|
||||
<h1 id="declaration-title">com.package1.classPropertyTypeReferences<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
<li><a href="#_classes">Classes</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">module <span class="name-decl">com.package1.classPropertyTypeReferences</span></div>
|
||||
<div class="doc-comment"><p>Class properties whose types reference classes from
|
||||
the same module, a different module, and external modules.</p></div>
|
||||
<dl class="member-info">
|
||||
<dt class="">Module URI:</dt>
|
||||
<dd><span class="import-uri">https://pkl.io/classPropertyTypeReferences.pkl</span><i class="copy-uri-button material-icons">content_copy</i></dd>
|
||||
<dt class="">Source code:</dt>
|
||||
<dd><a href="https://example.com/package1/classPropertyTypeReferences.pkl">classPropertyTypeReferences.pkl</a></dd>
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="output" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#output">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">output</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/ModuleOutput.html" class="name-ref">ModuleOutput</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The output of this module.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Defaults to all module properties rendered as either Pcf or the format specified on the command line.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="relativePathTo()" class="anchor"> </div>
|
||||
<div id="relativePathTo().other" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#relativePathTo()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">relativePathTo</span>(<span class="param1">other</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Module.html" class="name-ref">Module</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the relative, descendent directory path between this module and <code>other</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if no such path exists.</p>
|
||||
<p>For example, if module <code>mod1</code> has path <code>/dir1/mod1.pkl</code>, and module <code>mod2</code> has path <code>/dir1/dir2/dir3/mod2.pkl</code>,
|
||||
then <code>mod1.relativePathTo(mod2)</code> will return <code>List("dir2", "dir3")</code>.</p>
|
||||
<p>A common use case is to compute the directory path between a template located at the root of a hierarchy
|
||||
(say <code>rootModule.pkl</code>) and the currently evaluated module (accessible via the <code>module</code> keyword):</p>
|
||||
<pre><code>import "rootModule.pkl" // self-import
|
||||
path = rootModule.relativePathTo(module)
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_classes" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Classes</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="MyClass" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#MyClass">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="MyClass.html" class="name-decl">MyClass</a><a class="member-source-link" href="https://example.com/package1/classPropertyTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="TypeReferences" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#TypeReferences">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="TypeReferences.html" class="name-decl">TypeReferences</a><a class="member-source-link" href="https://example.com/package1/classPropertyTypeReferences.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
179
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/Address.html
vendored
Normal file
179
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/Address.html
vendored
Normal file
@@ -0,0 +1,179 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Address (com.package1/classTypeConstraints:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classTypeConstraints/Address.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classTypeConstraints" data-class-name="Address" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classTypeConstraints</a>
|
||||
<h1 id="declaration-title">Address<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">Address</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="street" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#street">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">street</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>(!isEmpty)<a class="member-source-link" href="https://example.com/package1/classTypeConstraints.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="city" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#city">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">city</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><a class="member-source-link" href="https://example.com/package1/classTypeConstraints.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Address.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Address.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
179
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/Person1.html
vendored
Normal file
179
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/Person1.html
vendored
Normal file
@@ -0,0 +1,179 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Person1 (com.package1/classTypeConstraints:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classTypeConstraints/Person1.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classTypeConstraints" data-class-name="Person1" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classTypeConstraints</a>
|
||||
<h1 id="declaration-title">Person1<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">Person1</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="name" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#name">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>(length >= 3)<a class="member-source-link" href="https://example.com/package1/classTypeConstraints.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="address" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#address">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">address</span>: <a href="Address.html" class="name-ref">Address</a>(street != city)<a class="member-source-link" href="https://example.com/package1/classTypeConstraints.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Person1.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Person1.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
168
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/Person2.html
vendored
Normal file
168
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/Person2.html
vendored
Normal file
@@ -0,0 +1,168 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Person2 (com.package1/classTypeConstraints:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classTypeConstraints/Person2.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classTypeConstraints" data-class-name="Person2" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classTypeConstraints</a>
|
||||
<h1 id="declaration-title">Person2<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">Person2</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="email" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#email">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">email</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>(emailAddress)<a class="member-source-link" href="https://example.com/package1/classTypeConstraints.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Person2.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Person2.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
179
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/Project.html
vendored
Normal file
179
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/Project.html
vendored
Normal file
@@ -0,0 +1,179 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Project (com.package1/classTypeConstraints:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classTypeConstraints/Project.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classTypeConstraints" data-class-name="Project" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a> > <a class="declaration-parent-link" href="index.html">com.package1.classTypeConstraints</a>
|
||||
<h1 id="declaration-title">Project<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">class <span class="name-decl">Project</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="type" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#type">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">type</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>(oneOf(List("open-source", "closed-source")))?<a class="member-source-link" href="https://example.com/package1/classTypeConstraints.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="contacts" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#contacts">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">contacts</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>(!isEmpty), <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>(emailAddress)>(length > 10, length < 20)<a class="member-source-link" href="https://example.com/package1/classTypeConstraints.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Any.html" class="name-ref">Any</a>.</span><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="Project.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="Project.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="context"><a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Typed.html" class="name-ref">Typed</a>.</span><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
257
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/index.html
vendored
Normal file
257
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/index.html
vendored
Normal file
@@ -0,0 +1,257 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>classTypeConstraints (com.package1:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/classTypeConstraints/index.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.classTypeConstraints" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a>
|
||||
<h1 id="declaration-title">com.package1.classTypeConstraints<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
<li><a href="#_classes">Classes</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">module <span class="name-decl">com.package1.classTypeConstraints</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="">Module URI:</dt>
|
||||
<dd><span class="import-uri">https://pkl.io/classTypeConstraints.pkl</span><i class="copy-uri-button material-icons">content_copy</i></dd>
|
||||
<dt class="">Source code:</dt>
|
||||
<dd><a href="https://example.com/package1/classTypeConstraints.pkl">classTypeConstraints.pkl</a></dd>
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="output" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#output">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">output</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/ModuleOutput.html" class="name-ref">ModuleOutput</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The output of this module.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Defaults to all module properties rendered as either Pcf or the format specified on the command line.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="emailAddress" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#emailAddress">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">emailAddress</span>: unknown<a class="member-source-link" href="https://example.com/package1/classTypeConstraints.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="relativePathTo()" class="anchor"> </div>
|
||||
<div id="relativePathTo().other" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#relativePathTo()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">relativePathTo</span>(<span class="param1">other</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Module.html" class="name-ref">Module</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the relative, descendent directory path between this module and <code>other</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if no such path exists.</p>
|
||||
<p>For example, if module <code>mod1</code> has path <code>/dir1/mod1.pkl</code>, and module <code>mod2</code> has path <code>/dir1/dir2/dir3/mod2.pkl</code>,
|
||||
then <code>mod1.relativePathTo(mod2)</code> will return <code>List("dir2", "dir3")</code>.</p>
|
||||
<p>A common use case is to compute the directory path between a template located at the root of a hierarchy
|
||||
(say <code>rootModule.pkl</code>) and the currently evaluated module (accessible via the <code>module</code> keyword):</p>
|
||||
<pre><code>import "rootModule.pkl" // self-import
|
||||
path = rootModule.relativePathTo(module)
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_classes" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Classes</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="Person1" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Person1">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Person1.html" class="name-decl">Person1</a><a class="member-source-link" href="https://example.com/package1/classTypeConstraints.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="Person2" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Person2">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Person2.html" class="name-decl">Person2</a><a class="member-source-link" href="https://example.com/package1/classTypeConstraints.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="Address" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Address">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Address.html" class="name-decl">Address</a><a class="member-source-link" href="https://example.com/package1/classTypeConstraints.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="Project" class="anchor"> </div>
|
||||
<div class="member with-page-link"><a class="member-selflink material-icons" href="#Project">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">class </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><a href="Project.html" class="name-decl">Project</a><a class="member-source-link" href="https://example.com/package1/classTypeConstraints.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
208
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/docExampleSubject1/index.html
vendored
Normal file
208
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/docExampleSubject1/index.html
vendored
Normal file
@@ -0,0 +1,208 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>docExampleSubject1 (com.package1:1.2.3) • Docsite Title</title>
|
||||
<script src="../../../scripts/pkldoc.js" defer="defer"></script>
|
||||
<script src="../../../scripts/scroll-into-view.min.js" defer="defer"></script>
|
||||
<script src="../../../data/com.package1/1.2.3/docExampleSubject1/index.js" defer="defer"></script>
|
||||
<link href="../../../styles/pkldoc.css" media="screen" type="text/css" rel="stylesheet">
|
||||
<link rel="icon" type="image/svg+xml" href="../../../images/favicon.svg">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="../../../images/apple-touch-icon.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="../../../images/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../../../images/favicon-16x16.png">
|
||||
<meta charset="UTF-8">
|
||||
</head>
|
||||
<body onload="onLoad()">
|
||||
<header>
|
||||
<div id="doc-title"><a href="../../../index.html">Docsite Title</a></div>
|
||||
<div id="search"><i id="search-icon" class="material-icons">search</i><input id="search-input" type="search" placeholder="Click or press 'S' to search this package" autocomplete="off" data-package-name="com.package1" data-package-version="1.2.3" data-package-url-prefix="../" data-module-name="com.package1.docExampleSubject1" data-root-url-prefix="../../../"></div>
|
||||
</header>
|
||||
<main><a class="declaration-parent-link" href="../../../index.html">Docsite Title</a> > <a class="declaration-parent-link" href="../index.html">com.package1</a>
|
||||
<h1 id="declaration-title">com.package1.docExampleSubject1<span id="declaration-version">1.2.3</span></h1>
|
||||
<ul class="member-group-links">
|
||||
<li><a href="#_properties">Properties</a></li>
|
||||
<li><a href="#_methods">Methods</a></li>
|
||||
</ul>
|
||||
<div id="_overview" class="anchor"> </div>
|
||||
<div id="_declaration" class="member">
|
||||
<div class="member-signature">module <span class="name-decl">com.package1.docExampleSubject1</span></div>
|
||||
<dl class="member-info">
|
||||
<dt class="">Module URI:</dt>
|
||||
<dd><span class="import-uri">https://pkl.io/docExampleSubject1.pkl</span><i class="copy-uri-button material-icons">content_copy</i></dd>
|
||||
<dt class="">Source code:</dt>
|
||||
<dd><a href="https://example.com/package1/docExampleSubject1.pkl">docExampleSubject1.pkl</a></dd>
|
||||
<dt class="">Examples:</dt>
|
||||
<dd><a href="https://example.com/package1/docExample.pkl">docExample</a>, <a href="https://example.com/package1/docExample2.pkl">docExample2</a></dd>
|
||||
<dt class="runtime-data hidden">Known subtypes:</dt>
|
||||
<dd id="known-subtypes" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">Known usages:</dt>
|
||||
<dd id="known-usages" class="runtime-data hidden"></dd>
|
||||
<dt class="runtime-data hidden">All versions:</dt>
|
||||
<dd id="known-versions" class="runtime-data hidden"></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_properties" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Properties<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="output" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#output">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">hidden </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">output</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/ModuleOutput.html" class="name-ref">ModuleOutput</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>The output of this module.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Defaults to all module properties rendered as either Pcf or the format specified on the command line.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="x" class="anchor"> </div>
|
||||
<div class="member"><a class="member-selflink material-icons" href="#x">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers"></div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">x</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a><a class="member-source-link" href="https://example.com/package1/docExampleSubject1.pkl#L123-L456">Source</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="member-group">
|
||||
<div id="_methods" class="anchor"> </div>
|
||||
<h2 class="member-group-title">Methods<span class="toggle-inherited-members">(<span class="toggle-inherited-members-link button-link">show inherited</span>)</span></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<div id="getClass()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#getClass()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getClass</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Class.html" class="name-ref">Class</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the class of <code>this</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toString()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#toString()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toString</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns a string representation of <code>this</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is used to convert the values of string interpolation expressions to strings.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="ifNonNull()" class="anchor"> </div>
|
||||
<div id="ifNonNull().Result" class="anchor-param1"> </div>
|
||||
<div id="ifNonNull().transform" class="anchor-param2"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#ifNonNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">ifNonNull</span><<a class="param1">Result</a>>(<span class="param2">transform</span>: (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html#NonNull" class="name-ref">NonNull</a>) -> <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>): <a href="index.html#ifNonNull().Result" class="name-ref">Result</a>?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns <code>this |> transform</code> if <code>this</code> is non-null, and <code>null</code> otherwise.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>This method is the complement of the <code>??</code> operator and the equivalent of an <code>Option</code> type's <code>map</code> and <code>flatMap</code> methods.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="hasProperty()" class="anchor"> </div>
|
||||
<div id="hasProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#hasProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">hasProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Boolean.html" class="name-ref">Boolean</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Tells if this object has a property with the given <code>name</code>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getProperty()" class="anchor"> </div>
|
||||
<div id="getProperty().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getProperty()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getProperty</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="getPropertyOrNull()" class="anchor"> </div>
|
||||
<div id="getPropertyOrNull().name" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#getPropertyOrNull()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">getPropertyOrNull</span>(<span class="param1">name</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>): unknown?<span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the value of the property with the given <code>name</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Returns <code>null</code> if a property with this name does not exist.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toDynamic()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toDynamic()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toDynamic</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html" class="name-ref">Dynamic</a><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Dynamic.html"><code>Dynamic</code></a> object.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="toMap()" class="anchor"> </div>
|
||||
<div class="member inherited expandable hidden collapsed"><a class="member-selflink material-icons" href="#toMap()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">toMap</span>(): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html" class="name-ref">Map</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>, unknown><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Converts this object to a <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Map.html"><code>Map</code></a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="relativePathTo()" class="anchor"> </div>
|
||||
<div id="relativePathTo().other" class="anchor-param1"> </div>
|
||||
<div class="member inherited expandable hidden collapsed with-expandable-docs"><i class="material-icons expandable-docs-icon">expand_more</i><a class="member-selflink material-icons" href="#relativePathTo()">link</a>
|
||||
<div class="member-left">
|
||||
<div class="member-modifiers">function </div>
|
||||
</div>
|
||||
<div class="member-main">
|
||||
<div class="member-signature"><span class="name-decl">relativePathTo</span>(<span class="param1">other</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Module.html" class="name-ref">Module</a>): <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a><<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>><span class="context"> (<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/index.html" class="name-ref">pkl.base</a>)</span><a class="member-source-link" href="https://github.com/apple/pkl/blob/0.24.0/stdlib/base.pkl#L123-L456">Source</a></div>
|
||||
<div class="doc-comment"><p>Returns the relative, descendent directory path between this module and <code>other</code>.</p></div>
|
||||
<div class="doc-comment expandable hidden collapsed"><p>Throws if no such path exists.</p>
|
||||
<p>For example, if module <code>mod1</code> has path <code>/dir1/mod1.pkl</code>, and module <code>mod2</code> has path <code>/dir1/dir2/dir3/mod2.pkl</code>,
|
||||
then <code>mod1.relativePathTo(mod2)</code> will return <code>List("dir2", "dir3")</code>.</p>
|
||||
<p>A common use case is to compute the directory path between a template located at the root of a hierarchy
|
||||
(say <code>rootModule.pkl</code>) and the currently evaluated module (accessible via the <code>module</code> keyword):</p>
|
||||
<pre><code>import "rootModule.pkl" // self-import
|
||||
path = rootModule.relativePathTo(module)
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user