Use https everywhere - documentation and samples
This commit is contained in:
committed by
Ilya Chernikov
parent
028a311949
commit
9ac52fad17
@@ -1,7 +1,7 @@
|
|||||||
[](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
|
[](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
|
||||||
[](https://teamcity.jetbrains.com/viewType.html?buildTypeId=Kotlin_dev_Compiler&branch_Kotlin_dev=%3Cdefault%3E&tab=buildTypeStatusDiv)
|
[](https://teamcity.jetbrains.com/viewType.html?buildTypeId=Kotlin_dev_Compiler&branch_Kotlin_dev=%3Cdefault%3E&tab=buildTypeStatusDiv)
|
||||||
[](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.jetbrains.kotlin%22)
|
[](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.jetbrains.kotlin%22)
|
||||||
[](http://www.apache.org/licenses/LICENSE-2.0)
|
[](https://www.apache.org/licenses/LICENSE-2.0)
|
||||||
|
|
||||||
# Kotlin Programming Language
|
# Kotlin Programming Language
|
||||||
|
|
||||||
@@ -15,7 +15,7 @@ Welcome to [Kotlin](https://kotlinlang.org/)! Some handy links:
|
|||||||
* [Forum](https://discuss.kotlinlang.org/)
|
* [Forum](https://discuss.kotlinlang.org/)
|
||||||
* [Kotlin Blog](https://blog.jetbrains.com/kotlin/)
|
* [Kotlin Blog](https://blog.jetbrains.com/kotlin/)
|
||||||
* [Follow Kotlin on Twitter](https://twitter.com/kotlin)
|
* [Follow Kotlin on Twitter](https://twitter.com/kotlin)
|
||||||
* [Public Slack channel](http://slack.kotlinlang.org/)
|
* [Public Slack channel](https://slack.kotlinlang.org/)
|
||||||
* [TeamCity CI build](https://teamcity.jetbrains.com/project.html?tab=projectOverview&projectId=Kotlin)
|
* [TeamCity CI build](https://teamcity.jetbrains.com/project.html?tab=projectOverview&projectId=Kotlin)
|
||||||
|
|
||||||
## Editing Kotlin
|
## Editing Kotlin
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ This is determined by the ```src/META-INF/services/org.jetbrains.kotlin.preloadi
|
|||||||
**Instrumenter** is any implementation of ```org.jetbrains.kotlin.preloading.instrumentation.Instrumenter``` interface.
|
**Instrumenter** is any implementation of ```org.jetbrains.kotlin.preloading.instrumentation.Instrumenter``` interface.
|
||||||
|
|
||||||
Preloader loads the **first** instrumenter service found on the class path.
|
Preloader loads the **first** instrumenter service found on the class path.
|
||||||
Services are provided through the [standard JDK mechanism](http://docs.oracle.com/javase/6/docs/api/java/util/ServiceLoader.html).
|
Services are provided through the [standard JDK mechanism](https://docs.oracle.com/javase/6/docs/api/java/util/ServiceLoader.html).
|
||||||
|
|
||||||
Every preloaded class is run through the instrumenter. Before exiting the program instrumenter's dump() method is called.
|
Every preloaded class is run through the instrumenter. Before exiting the program instrumenter's dump() method is called.
|
||||||
**Note** JDK classes and everything in the Preloader's own class path are not preloaded, thus not instrumented.
|
**Note** JDK classes and everything in the Preloader's own class path are not preloaded, thus not instrumented.
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
<id>com.your.company.unique.plugin.id</id>
|
<id>com.your.company.unique.plugin.id</id>
|
||||||
<name>Plugin display name here</name>
|
<name>Plugin display name here</name>
|
||||||
<version>1.0</version>
|
<version>1.0</version>
|
||||||
<vendor email="support@yourcompany.com" url="http://www.yourcompany.com">YourCompany</vendor>
|
<vendor email="support@yourcompany.com" url="https://www.yourcompany.com">YourCompany</vendor>
|
||||||
|
|
||||||
<description>< package, such as [this test case](../libraries/stdlib/test/text/StringNumberConversionTest.kt#L16) are automatically converted to JavaScript using [QUnit](http://qunitjs.com/).
|
Any Kotlin test cases using the **org.junit.Test** annotation and the [kotlin.test](../libraries/kotlin.test) package, such as [this test case](../libraries/stdlib/test/text/StringNumberConversionTest.kt#L16) are automatically converted to JavaScript using [QUnit](https://qunitjs.com/).
|
||||||
|
|
||||||
This allows the test cases to be [run directly in a web page in any web browser](../libraries/stdlib/js/ReadMe.md).
|
This allows the test cases to be [run directly in a web page in any web browser](../libraries/stdlib/js/ReadMe.md).
|
||||||
|
|
||||||
|
|||||||
@@ -1,20 +1,20 @@
|
|||||||
# Kotlin Programming Language
|
# Kotlin Programming Language
|
||||||
|
|
||||||
Welcome to [Kotlin](http://kotlinlang.org/)! Some handy links:
|
Welcome to [Kotlin](https://kotlinlang.org/)! Some handy links:
|
||||||
|
|
||||||
* [Kotlin Site](http://kotlinlang.org/)
|
* [Kotlin Site](https://kotlinlang.org/)
|
||||||
* [Getting Started Guide](http://kotlinlang.org/docs/tutorials/javascript/getting-started-idea/getting-started-with-intellij-idea.html)
|
* [Getting Started Guide](https://kotlinlang.org/docs/tutorials/javascript/getting-started-idea/getting-started-with-intellij-idea.html)
|
||||||
* [Try Kotlin](http://try.kotlinlang.org/)
|
* [Try Kotlin](https://try.kotlinlang.org/)
|
||||||
* [Kotlin Standard Library](http://kotlinlang.org/api/latest/jvm/stdlib/index.html)
|
* [Kotlin Standard Library](https://kotlinlang.org/api/latest/jvm/stdlib/index.html)
|
||||||
* [Issue Tracker](http://youtrack.jetbrains.com/issues/KT)
|
* [Issue Tracker](https://youtrack.jetbrains.com/issues/KT)
|
||||||
* [Forum](https://discuss.kotlinlang.org/)
|
* [Forum](https://discuss.kotlinlang.org/)
|
||||||
* [Kotlin Blog](http://blog.jetbrains.com/kotlin/)
|
* [Kotlin Blog](https://blog.jetbrains.com/kotlin/)
|
||||||
* [Follow Kotlin on Twitter](https://twitter.com/kotlin)
|
* [Follow Kotlin on Twitter](https://twitter.com/kotlin)
|
||||||
* [Public Slack channel](http://slack.kotlinlang.org/)
|
* [Public Slack channel](https://slack.kotlinlang.org/)
|
||||||
* [TeamCity CI build](https://teamcity.jetbrains.com/project.html?tab=projectOverview&projectId=Kotlin)
|
* [TeamCity CI build](https://teamcity.jetbrains.com/project.html?tab=projectOverview&projectId=Kotlin)
|
||||||
|
|
||||||
## Editing Kotlin
|
## Editing Kotlin
|
||||||
|
|
||||||
* [Kotlin IntelliJ IDEA Plugin](https://kotlinlang.org/docs/tutorials/getting-started.html)
|
* [Kotlin IntelliJ IDEA Plugin](https://kotlinlang.org/docs/tutorials/getting-started.html)
|
||||||
* [Kotlin Eclipse Plugin](http://kotlinlang.org/docs/tutorials/getting-started-eclipse.html)
|
* [Kotlin Eclipse Plugin](https://kotlinlang.org/docs/tutorials/getting-started-eclipse.html)
|
||||||
* [Kotlin TextMate Bundle](https://github.com/vkostyukov/kotlin-sublime-package)
|
* [Kotlin TextMate Bundle](https://github.com/vkostyukov/kotlin-sublime-package)
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ compiler output for performing assertions in tests, independently of the test fr
|
|||||||
|
|
||||||
The library includes out-of-the-box support for [Jasmine](https://jasmine.github.io/),
|
The library includes out-of-the-box support for [Jasmine](https://jasmine.github.io/),
|
||||||
[Mocha](https://mochajs.org/), [Jest](https://facebook.github.io/jest/),
|
[Mocha](https://mochajs.org/), [Jest](https://facebook.github.io/jest/),
|
||||||
and [QUnit](http://qunitjs.com).
|
and [QUnit](https://qunitjs.com).
|
||||||
|
|
||||||
Try out the [examples](https://github.com/JetBrains/kotlin-examples/tree/master/gradle/js-tests),
|
Try out the [examples](https://github.com/JetBrains/kotlin-examples/tree/master/gradle/js-tests),
|
||||||
read the [forum post](https://discuss.kotlinlang.org/t/unit-testing-in-kotlin-js/3943)
|
read the [forum post](https://discuss.kotlinlang.org/t/unit-testing-in-kotlin-js/3943)
|
||||||
@@ -14,19 +14,19 @@ for more information.
|
|||||||
|
|
||||||
## Handy links
|
## Handy links
|
||||||
|
|
||||||
* [Kotlin Site](http://kotlinlang.org/)
|
* [Kotlin Site](https://kotlinlang.org/)
|
||||||
* [Getting Started Guide](http://kotlinlang.org/docs/tutorials/javascript/getting-started-idea/getting-started-with-intellij-idea.html)
|
* [Getting Started Guide](https://kotlinlang.org/docs/tutorials/javascript/getting-started-idea/getting-started-with-intellij-idea.html)
|
||||||
* [Try Kotlin](http://try.kotlinlang.org/)
|
* [Try Kotlin](https://try.kotlinlang.org/)
|
||||||
* [Kotlin Standard Library](http://kotlinlang.org/api/latest/jvm/stdlib/index.html)
|
* [Kotlin Standard Library](https://kotlinlang.org/api/latest/jvm/stdlib/index.html)
|
||||||
* [Issue Tracker](http://youtrack.jetbrains.com/issues/KT)
|
* [Issue Tracker](https://youtrack.jetbrains.com/issues/KT)
|
||||||
* [Forum](https://discuss.kotlinlang.org/)
|
* [Forum](https://discuss.kotlinlang.org/)
|
||||||
* [Kotlin Blog](http://blog.jetbrains.com/kotlin/)
|
* [Kotlin Blog](https://blog.jetbrains.com/kotlin/)
|
||||||
* [Follow Kotlin on Twitter](https://twitter.com/kotlin)
|
* [Follow Kotlin on Twitter](https://twitter.com/kotlin)
|
||||||
* [Public Slack channel](http://slack.kotlinlang.org/)
|
* [Public Slack channel](https://slack.kotlinlang.org/)
|
||||||
* [TeamCity CI build](https://teamcity.jetbrains.com/project.html?tab=projectOverview&projectId=Kotlin)
|
* [TeamCity CI build](https://teamcity.jetbrains.com/project.html?tab=projectOverview&projectId=Kotlin)
|
||||||
|
|
||||||
## Editing Kotlin
|
## Editing Kotlin
|
||||||
|
|
||||||
* [Kotlin IntelliJ IDEA Plugin](https://kotlinlang.org/docs/tutorials/getting-started.html)
|
* [Kotlin IntelliJ IDEA Plugin](https://kotlinlang.org/docs/tutorials/getting-started.html)
|
||||||
* [Kotlin Eclipse Plugin](http://kotlinlang.org/docs/tutorials/getting-started-eclipse.html)
|
* [Kotlin Eclipse Plugin](https://kotlinlang.org/docs/tutorials/getting-started-eclipse.html)
|
||||||
* [Kotlin TextMate Bundle](https://github.com/vkostyukov/kotlin-sublime-package)
|
* [Kotlin TextMate Bundle](https://github.com/vkostyukov/kotlin-sublime-package)
|
||||||
|
|||||||
@@ -1,20 +1,20 @@
|
|||||||
# Kotlin Programming Language
|
# Kotlin Programming Language
|
||||||
|
|
||||||
Welcome to [Kotlin](http://kotlinlang.org/)! Some handy links:
|
Welcome to [Kotlin](https://kotlinlang.org/)! Some handy links:
|
||||||
|
|
||||||
* [Kotlin Site](http://kotlinlang.org/)
|
* [Kotlin Site](https://kotlinlang.org/)
|
||||||
* [Getting Started Guide](http://kotlinlang.org/docs/tutorials/javascript/getting-started-idea/getting-started-with-intellij-idea.html)
|
* [Getting Started Guide](https://kotlinlang.org/docs/tutorials/javascript/getting-started-idea/getting-started-with-intellij-idea.html)
|
||||||
* [Try Kotlin](http://try.kotlinlang.org/)
|
* [Try Kotlin](https://try.kotlinlang.org/)
|
||||||
* [Kotlin Standard Library](http://kotlinlang.org/api/latest/jvm/stdlib/index.html)
|
* [Kotlin Standard Library](https://kotlinlang.org/api/latest/jvm/stdlib/index.html)
|
||||||
* [Issue Tracker](http://youtrack.jetbrains.com/issues/KT)
|
* [Issue Tracker](https://youtrack.jetbrains.com/issues/KT)
|
||||||
* [Forum](https://discuss.kotlinlang.org/)
|
* [Forum](https://discuss.kotlinlang.org/)
|
||||||
* [Kotlin Blog](http://blog.jetbrains.com/kotlin/)
|
* [Kotlin Blog](https://blog.jetbrains.com/kotlin/)
|
||||||
* [Follow Kotlin on Twitter](https://twitter.com/kotlin)
|
* [Follow Kotlin on Twitter](https://twitter.com/kotlin)
|
||||||
* [Public Slack channel](http://slack.kotlinlang.org/)
|
* [Public Slack channel](https://slack.kotlinlang.org/)
|
||||||
* [TeamCity CI build](https://teamcity.jetbrains.com/project.html?tab=projectOverview&projectId=Kotlin)
|
* [TeamCity CI build](https://teamcity.jetbrains.com/project.html?tab=projectOverview&projectId=Kotlin)
|
||||||
|
|
||||||
## Editing Kotlin
|
## Editing Kotlin
|
||||||
|
|
||||||
* [Kotlin IntelliJ IDEA Plugin](https://kotlinlang.org/docs/tutorials/getting-started.html)
|
* [Kotlin IntelliJ IDEA Plugin](https://kotlinlang.org/docs/tutorials/getting-started.html)
|
||||||
* [Kotlin Eclipse Plugin](http://kotlinlang.org/docs/tutorials/getting-started-eclipse.html)
|
* [Kotlin Eclipse Plugin](https://kotlinlang.org/docs/tutorials/getting-started-eclipse.html)
|
||||||
* [Kotlin TextMate Bundle](https://github.com/vkostyukov/kotlin-sublime-package)
|
* [Kotlin TextMate Bundle](https://github.com/vkostyukov/kotlin-sublime-package)
|
||||||
|
|||||||
+1
-1
@@ -22,7 +22,7 @@ You can work with the maven modules of this maven project in IDEA from the [root
|
|||||||
|
|
||||||
### Building
|
### Building
|
||||||
|
|
||||||
You need to install a recent (at least 3.3) [Maven](http://maven.apache.org/) distribution.
|
You need to install a recent (at least 3.3) [Maven](https://maven.apache.org/) distribution.
|
||||||
|
|
||||||
Before building this Maven project you need to build and install the required artifacts built with Gradle to the local maven repository, by issuing the following command in the root project:
|
Before building this Maven project you need to build and install the required artifacts built with Gradle to the local maven repository, by issuing the following command in the root project:
|
||||||
|
|
||||||
|
|||||||
@@ -75,7 +75,7 @@
|
|||||||
<sourceRoot path="stdlib/common/src" />
|
<sourceRoot path="stdlib/common/src" />
|
||||||
<sourceRoot path="stdlib/src" />
|
<sourceRoot path="stdlib/src" />
|
||||||
|
|
||||||
<sourcelink path=".." url="http://github.com/JetBrains/kotlin/blob/${github.revision}" linesuffix="#L"/>
|
<sourcelink path=".." url="https://github.com/JetBrains/kotlin/blob/${github.revision}" linesuffix="#L"/>
|
||||||
|
|
||||||
<!-- TODO Docs? -->
|
<!-- TODO Docs? -->
|
||||||
<packageOptions prefix="org.w3c" reportUndocumented="false"/>
|
<packageOptions prefix="org.w3c" reportUndocumented="false"/>
|
||||||
@@ -93,9 +93,9 @@
|
|||||||
<sourceRoot path="kotlin.test/testng/src/main/kotlin" platforms="JVM"/>
|
<sourceRoot path="kotlin.test/testng/src/main/kotlin" platforms="JVM"/>
|
||||||
<sourceRoot path="kotlin.test/js/src/main/kotlin" platforms="JS"/>
|
<sourceRoot path="kotlin.test/js/src/main/kotlin" platforms="JS"/>
|
||||||
|
|
||||||
<sourcelink path=".." url="http://github.com/JetBrains/kotlin/blob/${github.revision}" linesuffix="#L"/>
|
<sourcelink path=".." url="https://github.com/JetBrains/kotlin/blob/${github.revision}" linesuffix="#L"/>
|
||||||
<ExternalDocumentationLink url="https://kotlinlang.org/api/latest/jvm/stdlib/" packageListUrl="${stdlib.package.list}" />
|
<ExternalDocumentationLink url="https://kotlinlang.org/api/latest/jvm/stdlib/" packageListUrl="${stdlib.package.list}" />
|
||||||
<ExternalDocumentationLink url="http://junit.org/junit4/javadoc/latest/" />
|
<ExternalDocumentationLink url="https://junit.org/junit4/javadoc/latest/" />
|
||||||
<packageoptions prefix="org.junit" skipdeprecated="true"/>
|
<packageoptions prefix="org.junit" skipdeprecated="true"/>
|
||||||
</dokka>
|
</dokka>
|
||||||
</target>
|
</target>
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
This (really simple ;) application shows how to use Kotlin and the maven plugin to generate JavaScript and invoke it from inside a HTML web page.
|
This (really simple ;) application shows how to use Kotlin and the maven plugin to generate JavaScript and invoke it from inside a HTML web page.
|
||||||
|
|
||||||
The source [Hello.kt](https://github.com/JetBrains/kotlin/blob/master/libraries/examples/browser-example-with-library/src/main/kotlin/sample/Hello.kt) uses the [kotlin.browser](http://jetbrains.github.com/kotlin/versions/snapshot/apidocs/kotlin/browser/package-summary.html) API to access the *document* property to modify the HTML.
|
The source [Hello.kt](https://github.com/JetBrains/kotlin/blob/master/libraries/examples/browser-example-with-library/src/main/kotlin/sample/Hello.kt) uses the [kotlin.browser](https://jetbrains.github.com/kotlin/versions/snapshot/apidocs/kotlin/browser/package-summary.html) API to access the *document* property to modify the HTML.
|
||||||
|
|
||||||
### Running the sample in a web browser
|
### Running the sample in a web browser
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
This (really simple ;) application shows how to use Kotlin and the maven plugin to generate JavaScript and invoke it from inside a HTML web page.
|
This (really simple ;) application shows how to use Kotlin and the maven plugin to generate JavaScript and invoke it from inside a HTML web page.
|
||||||
|
|
||||||
The source [Hello.kt](https://github.com/JetBrains/kotlin/blob/master/libraries/examples/browser-example/src/main/kotlin/sample/Hello.kt) uses the [kotlin.browser](http://jetbrains.github.com/kotlin/versions/snapshot/apidocs/kotlin/browser/package-summary.html) API to access the *document* property to modify the HTML.
|
The source [Hello.kt](https://github.com/JetBrains/kotlin/blob/master/libraries/examples/browser-example/src/main/kotlin/sample/Hello.kt) uses the [kotlin.browser](https://jetbrains.github.com/kotlin/versions/snapshot/apidocs/kotlin/browser/package-summary.html) API to access the *document* property to modify the HTML.
|
||||||
|
|
||||||
### Running the sample in a web browser
|
### Running the sample in a web browser
|
||||||
|
|
||||||
@@ -14,11 +14,11 @@ To run the example try:
|
|||||||
|
|
||||||
This should open a browser which then shows some simple HTML which then includes some dynamically generated content.
|
This should open a browser which then shows some simple HTML which then includes some dynamically generated content.
|
||||||
|
|
||||||
## Running the sample on Java 7 with JavaFX and [kool.io](http://kool.io/)'s browser
|
## Running the sample on Java 7 with JavaFX and [kool.io](https://kool.io/)'s browser
|
||||||
|
|
||||||
You can also run the sample as Java code on a JVM using JavaFX (which includes its own webkit rendering engine for HTML / CSS / JS support) using the [kool.io JavaFX browser](https://github.com/koolio/kool/blob/master/samples/kool-template-sample/ReadMe.md).
|
You can also run the sample as Java code on a JVM using JavaFX (which includes its own webkit rendering engine for HTML / CSS / JS support) using the [kool.io JavaFX browser](https://github.com/koolio/kool/blob/master/samples/kool-template-sample/ReadMe.md).
|
||||||
|
|
||||||
First you need to install [Java 7 update 4](http://www.oracle.com/technetwork/java/javase/overview/index.html) or later which ships with JavaFX.
|
First you need to install [Java 7 update 4](https://www.oracle.com/technetwork/java/javase/overview/index.html) or later which ships with JavaFX.
|
||||||
|
|
||||||
You will need to setup **JAVA_HOME** and **PATH** environment variables to point to the latest JDK. If you install Java 7 and use a Mac you might want to run this first...
|
You will need to setup **JAVA_HOME** and **PATH** environment variables to point to the latest JDK. If you install Java 7 and use a Mac you might want to run this first...
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
## The Kotlin Standard Library
|
## The Kotlin Standard Library
|
||||||
|
|
||||||
This module creates the [standard library for Kotlin](http://kotlinlang.org/api/latest/jvm/stdlib/index.html).
|
This module creates the [standard library for Kotlin](https://kotlinlang.org/api/latest/jvm/stdlib/index.html).
|
||||||
|
|
||||||
### Notes for contributors
|
### Notes for contributors
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
This project contains samples for the standard library functions.
|
This project contains samples for the standard library functions.
|
||||||
They are located in the [test](test) source root and each sample is written like a small unit test.
|
They are located in the [test](test) source root and each sample is written like a small unit test.
|
||||||
Then these samples are referenced in the documentation of the standard library functions
|
Then these samples are referenced in the documentation of the standard library functions
|
||||||
with the [`@sample`](http://kotlinlang.org/docs/reference/kotlin-doc.html#block-tags) tag and are embedded in the generated documentation as runnable samples.
|
with the [`@sample`](https://kotlinlang.org/docs/reference/kotlin-doc.html#block-tags) tag and are embedded in the generated documentation as runnable samples.
|
||||||
|
|
||||||
|
|
||||||
### Guides for sample authoring
|
### Guides for sample authoring
|
||||||
|
|||||||
Reference in New Issue
Block a user