Documentation stubs for new packages.

This commit is contained in:
Ilya Gorbunov
2016-01-23 01:44:05 +03:00
parent 0c32fab690
commit 7105c7c182
+28 -23
View File
@@ -2,8 +2,12 @@
## Kotlin Standard Library ## Kotlin Standard Library
The Kotlin standard library is a set of functions and types implementing idiomatic patterns when working with collections, The Kotlin Standard Library provides living essentials for everyday work with Kotlin.
text and files. These include:
- Higher-order functions implementing idiomatic patterns ([let], [apply], [use], [synchronized], etc).
- Extension functions providing querying operations for collections (eager) and sequences (lazy).
- Various utilities for working with strings and char sequences.
- Extensions for JDK classes making it convenient to work with files, IO, and threading.
# Package kotlin # Package kotlin
@@ -13,40 +17,35 @@ Core functions and types, available on all supported platforms.
Library support for the Kotlin annotation facility. Library support for the Kotlin annotation facility.
# Package kotlin.browser # Package kotlin.collections
API to access the web browser DOM. Collection types, such as [Iterable], [Collection], [List], [Set], [Map] and related top-level and extension functions.
# Package kotlin.comparisons
[Comparator] factory and extension functions and comparison helper functions.
# Package kotlin.concurrent # Package kotlin.concurrent
Utility functions for concurrent programming. Utility functions for concurrent programming.
# Package kotlin.dom # Package kotlin.io
Functions for working with the W3C DOM. IO API for working with files and streams.
# Package kotlin.jvm # Package kotlin.jvm
Functions and annotations specific to the Java platform. Functions and annotations specific to the Java platform.
# Package kotlin.io
IO API for working with files and streams.
# Package kotlin.math
Mathematics API.
# Package kotlin.platform
APIs for customizing the code generated by the Kotlin compiler for better interoperability with
other code on the target platform.
# Package kotlin.properties # Package kotlin.properties
Standard implementations of delegates for [delegated properties](/docs/reference/delegated-properties.html) Standard implementations of delegates for [delegated properties](/docs/reference/delegated-properties.html)
and helper functions for implementing custom delegates. and helper functions for implementing custom delegates.
# Package kotlin.ranges
[Ranges](/docs/reference/ranges.html), Progressions and related top-level and extension functions.
# Package kotlin.reflect # Package kotlin.reflect
Runtime API for [Kotlin reflection](/docs/reference/reflection.html) Runtime API for [Kotlin reflection](/docs/reference/reflection.html)
@@ -56,14 +55,20 @@ Runtime API for [Kotlin reflection](/docs/reference/reflection.html)
Runtime API for interoperability between [Kotlin reflection](/docs/reference/reflection.html) and Runtime API for interoperability between [Kotlin reflection](/docs/reference/reflection.html) and
Java reflection. Java reflection.
# Package kotlin.sequences
[Sequence] type that represents lazily evaluated collections. Top-level functions for instantiating sequences
and extension functions for sequences.
# Package kotlin.system
System-related utility functions.
# Package kotlin.test # Package kotlin.test
Functions for writing tests. Functions for writing test assertions.
# Package kotlin.text # Package kotlin.text
Functions for working with text and regular expressions. Functions for working with text and regular expressions.
# Package kotlin.util
Utility functions.