Updated documentation to R14

2020-10-22 19:26:16 +02:00
parent 99ffe08258
commit 8a0a49e63d
1097 changed files with 64786 additions and 24939 deletions
--- a/docs/styles/jetbrains-mono.css
+++ b/docs/styles/jetbrains-mono.css
@@ -1,13 +1,19 @@
@font-face{
    font-family: 'JetBrains Mono';
-    src: url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/web/woff2/JetBrainsMono-Regular.woff2') format('woff2');
+    src: url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/web/JetBrainsMono-Regular.eot') format('embedded-opentype'),
+         url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/web/JetBrainsMono-Regular.woff2') format('woff2'),
+         url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/web/JetBrainsMono-Regular.woff') format('woff'),
+         url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/ttf/JetBrainsMono-Regular.ttf') format('truetype');
    font-weight: normal;
    font-style: normal;
 }

@font-face{
    font-family: 'JetBrains Mono';
-    src: url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/web/woff2/JetBrainsMono-Bold.woff2') format('woff2');
-    font-weight: bold;
+    src: url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/web/JetBrainsMono-Bold.eot') format('embedded-opentype'),
+         url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/web/JetBrainsMono-Bold.woff2') format('woff2'),
+         url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/web/JetBrainsMono-Bold.woff') format('woff'),
+         url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/ttf/JetBrainsMono-Bold.ttf') format('truetype');
+    font-weight: normal;
    font-style: normal;
 }
--- a/docs/styles/logo-styles.css
+++ b/docs/styles/logo-styles.css
@@ -0,0 +1,3 @@
+#logo {
+    background-image: url(../images/docs_logo.svg);
+}
--- a/docs/styles/main.css
+++ b/docs/styles/main.css
@@ -0,0 +1,113 @@
+.search button{border:none;fill:#637282;background:#f4f4f4;cursor:pointer}.search button:focus{outline:none}.popup-wrapper{min-width:calc(100% - 360px) !important}@media screen and (max-width: 759px){.popup-wrapper{min-width:100% !important}}.template-wrapper{height:32px;display:grid;grid-template-columns:auto auto}.template-wrapper span{line-height:32px}@media screen and (max-width: 759px){.template-wrapper{display:flex;height:auto;flex-direction:column}.template-wrapper span{line-height:unset}}.template-name{justify-self:start}.template-description{color:gray;justify-self:end}
+/* stylelint-disable color-no-hex */
+
+:root {
+  --ring-unit: 8px;
+
+  /* Element */
+  --ring-line-color: #dfe5eb;
+  --ring-dark-line-color: #475159;
+  --ring-borders-color: #b8d1e5;
+  --ring-dark-borders-color: #406380;
+  --ring-icon-color: var(--ring-borders-color);
+  --ring-icon-secondary-color: #999;
+  --ring-border-disabled-color: #dbdbdb;
+  --ring-icon-disabled-color: #bbb;
+  --ring-border-hover-color: #80c6ff;
+  --ring-dark-border-hover-color: #70b1e6;
+  --ring-icon-hover-color: var(--ring-link-hover-color);
+  --ring-main-color: #008eff;
+  --ring-main-hover-color: #007ee5;
+  --ring-icon-error-color: #db5860;
+  --ring-icon-warning-color: #eda200;
+  --ring-icon-success-color: #59a869;
+  --ring-pale-control-color: #cfdbe5;
+  --ring-popup-border-components: 0, 42, 76;
+  --ring-popup-border-color: rgba(var(--ring-popup-border-components), 0.1);
+  --ring-popup-shadow-color: rgba(var(--ring-popup-border-components), 0.15);
+  --ring-message-shadow-color: rgba(var(--ring-popup-border-components), 0.3);
+  --ring-pinned-shadow-color: #737577;
+
+  /* Text */
+  --ring-search-color: #669ecc;
+  --ring-hint-color: #406380;
+  --ring-link-color: #0f5b99;
+  --ring-link-hover-color: #ff008c;
+  --ring-error-color: #c22731;
+  --ring-warning-color: #cc8b00;
+  --ring-success-color: #1b8833;
+  --ring-text-color: #1f2326;
+  --ring-dark-text-color: #fff;
+  --ring-heading-color: var(--ring-text-color);
+  --ring-secondary-color: #737577;
+  --ring-dark-secondary-color: #888;
+  --ring-disabled-color: #999;
+  --ring-dark-disabled-color: #444;
+  --ring-dark-active-color: #ccc;
+
+  /* Background */
+  --ring-content-background-color: #fff;
+  --ring-popup-background-color: #fff;
+  --ring-sidebar-background-color: #f7f9fa;
+  --ring-selected-background-color: #d4edff;
+  --ring-hover-background-color: #ebf6ff;
+  --ring-dark-selected-background-color: #002a4d;
+  --ring-message-background-color: #111314;
+  --ring-navigation-background-color: #000;
+  --ring-tag-background-color: #e6ecf2;
+  --ring-removed-background-color: #ffd5cb;
+  --ring-warning-background-color: #faeccd;
+  --ring-added-background-color: #bce8bb;
+
+  /* Code */
+  --ring-code-background-color: var(--ring-content-background-color);
+  --ring-code-color: #000;
+  --ring-code-comment-color: #707070;
+  --ring-code-meta-color: #707070;
+  --ring-code-keyword-color: #000080;
+  --ring-code-tag-background-color: #efefef;
+  --ring-code-tag-color: var(--ring-code-keyword-color);
+  --ring-code-tag-font-weight: bold;
+  --ring-code-field-color: #660e7a;
+  --ring-code-attribute-color: #00f;
+  --ring-code-number-color: var(--ring-code-attribute-color);
+  --ring-code-string-color: #007a00;
+  --ring-code-addition-color: #aadeaa;
+  --ring-code-deletion-color: #c8c8c8;
+
+  /* Metrics */
+  --ring-border-radius: 3px;
+  --ring-border-radius-small: 2px;
+  --ring-font-size-larger: 14px;
+  --ring-font-size: 13px;
+  --ring-font-size-smaller: 12px;
+  --ring-line-height-taller: 21px;
+  --ring-line-height: 20px;
+  --ring-line-height-lower: 18px;
+  --ring-line-height-lowest: 16px;
+  --ring-ease: 0.3s ease-out;
+  --ring-fast-ease: 0.15s ease-out;
+  --ring-font-family: system-ui, Arial, sans-serif;
+  --ring-font-family-monospace: Menlo, "Bitstream Vera Sans Mono", "Ubuntu Mono", Consolas, "Courier New", Courier, monospace;
+
+  /* Common z-index-values */
+
+  /* Invisible element is an absolutely positioned element which should be below */
+  /* all other elements on the page */
+  --ring-invisible-element-z-index: -1;
+
+  /* z-index for position: fixed elements */
+  --ring-fixed-z-index: 1;
+
+  /* Elements that should overlay all other elements on the page */
+  --ring-overlay-z-index: 5;
+
+  /* Alerts should de displayed above overlays */
+  --ring-alert-z-index: 6;
+}
+
+html,.app-root{height:100%}.search-root{margin:0;padding:0;background:var(--ring-content-background-color);font-family:var(--ring-font-family);font-size:var(--ring-font-size);line-height:var(--ring-line-height)}.search-content{padding-top:24px;margin:0 41px;position:absolute;top:0;right:0;z-index:8;background-color:#f4f4f4}@media screen and (max-width: 759px){.search-content{margin:0 8px}}
+div#paneSearch{width:248px;margin:0 auto}div#paneSearch input#navigation-pane-search{background:#fff;border:1px solid #dadfe6;box-sizing:border-box;border-radius:4px;padding:8px;height:40px}div#paneSearch .navigation-pane-search{padding-top:16px;width:100%}div#paneSearch div.paneSearchInputWrapper{position:relative}div#paneSearch div.paneSearchInputWrapper span.paneSearchInputClearIcon{position:absolute;top:calc(50% + 2px);right:8px;cursor:pointer}.navigation-pane-popup{margin-top:1.2em}
+.page-summary{background:#fff;border:1px solid #dadfe6;position:fixed;top:25%;max-height:70vh;right:-2px;width:250px;z-index:8;transition:width .2s}.page-summary.hidden{width:3em;writing-mode:vertical-rl;text-orientation:mixed}.page-summary.hidden .content-wrapper h4{margin:0;padding:8px}.page-summary .content-wrapper{padding:.5em 0 1em 0;letter-spacing:.2px}.page-summary .content-wrapper h4{margin:0 2em;font-weight:600}.page-summary .content-wrapper ul{list-style-type:none;width:100%;padding:0;margin:1em 0;overflow-x:hidden;overflow-y:auto;max-height:60vh}.page-summary .content-wrapper ul li{width:100%;padding:4px 0}.page-summary .content-wrapper ul li:hover{background:rgba(91,93,239,.15)}.page-summary .content-wrapper ul li>a{margin:0 2em}.page-summary .content-wrapper ul li.selected{border-left:4px solid #5b5def}@media screen and (max-width: 759px){.page-summary{display:none}}
+
+/*# sourceMappingURL=main.css.map*/
--- a/docs/styles/style.css
+++ b/docs/styles/style.css
@@ -3,17 +3,18 @@
@import url('jetbrains-mono.css');

 :root {
-    --breadcrumb-font-color: #A6AFBA;
+    --breadcrumb-font-color: #637282;
    --hover-link-color: #5B5DEF;
    --average-color: #637282;
    --footer-height: 64px;
    --footer-padding-top: 48px;
    --horizontal-spacing-for-content: 42px;
    --mobile-horizontal-spacing-for-content: 8px;
+    --bottom-spacing: 16px;
 }

 #content {
-    padding: 0 var(--horizontal-spacing-for-content);
+    padding: 0 var(--horizontal-spacing-for-content) var(--bottom-spacing) var(--horizontal-spacing-for-content);
 }

 .breadcrumbs {
@@ -58,12 +59,11 @@
 }

 .tabs-section-body {
-    margin: 12px 0;
    background-color: white;
 }

-.tabs-section-body > .table {
-    margin: 12px 0;
+.tabs-section-body > div {
+    margin-top: 12px;
 }

 .tabs-section-body .with-platform-tabs > div {
@@ -85,9 +85,9 @@
 }

 .cover > .platform-hinted {
-    padding-top: 24px;
-    margin-top: 24px;
-    padding-bottom: 16px;
+    padding-top: 12px;
+    margin-top: 12px;
+    padding-bottom: 12px;
 }

 .cover {
@@ -96,10 +96,6 @@
    width: 100%;
 }

-.tabbedcontent {
-    padding: 14px 0;
-}
-
 .cover .platform-hinted .sourceset-depenent-content > .symbol,
 .cover > .symbol {
    background-color: white;
@@ -134,9 +130,13 @@
    width: 100%;
 }

+.cover p.paragraph {
+    margin-top: 4px;
+}
+
 .divergent-group {
    background-color: white;
-    padding: 16px 8px;
+    padding: 8px 0px 8px 0;
    margin-bottom: 2px;
 }

@@ -168,15 +168,15 @@

 #leftColumn {
    width: 280px;
-    min-height: 100%;
    border-right: 1px solid #DADFE6;
-    flex: 0 0 auto;
+    display: flex;
+    flex-direction: column;
 }

 #sideMenu {
-    max-height: calc(100% - 140px);
    padding-top: 16px;
    position: relative;
+    max-height: calc(100% - 140px);
 }

 #sideMenu img {
@@ -195,7 +195,6 @@
    background-size: 125px 26px;
    border-bottom: 1px solid #DADFE6;
    background-repeat: no-repeat;
-    background-image: url(../images/docs_logo.svg);
    background-origin: content-box;
    padding-left: 24px;
    padding-top: 24px;
@@ -243,6 +242,13 @@ code.paragraph {
    font-weight: bold;
    position: relative;
    line-height: 24px;
+    font-family: JetBrains Mono, Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal;
+    font-size: 14px;
+    min-height: 43px;
+}
+
+.symbol > a {
+    color: var(--hover-link-color);
 }

 .copy-icon {
@@ -318,6 +324,12 @@ code.paragraph {
    overflow: hidden;
 }

+
+.sideMenuPart a:hover {
+    text-decoration: none;
+    color: var(--average-color);
+}
+
 .sideMenuPart > .overview:before {
    box-sizing: border-box;
    content: '';
@@ -403,16 +415,6 @@ td:first-child {
    font-size: 12px;
 }

-.symbol {
-    font-family: JetBrains Mono, Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal;
-    font-size: 12px;
-    min-height: 43px;
-}
-
-.symbol > a {
-    color: var(--hover-link-color);
-}
-
 .identifier {
    color: darkblue;
    font-size: 12px;
@@ -422,7 +424,6 @@ td:first-child {
 .brief {
    white-space: pre-wrap;
    overflow: hidden;
-    padding-top: 8px;
 }

 h1, h2, h3, h4, h5, h6 {
@@ -479,10 +480,19 @@ h3, h4, h5, h6 {
 }

 .UnderCoverText {
-    font-size: 18px;
+    font-size: 16px;
    line-height: 28px;
 }

+.UnderCoverText code {
+    font-size: inherit;
+}
+
+.UnderCoverText table {
+    margin: 8px 0 8px 0;
+}
+
+
 a {
    color: #5B5DEF;
    font-weight: 400;
@@ -514,9 +524,8 @@ blockquote {
 }

 code, pre {
-    font-family: Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal;
    color: #333;
-    font-size: 12px;
+    font-size: 14px;
 }

 pre {
@@ -653,20 +662,23 @@ footer {
    letter-spacing: normal;
    text-align: center;
    outline: none;
-
    color: #fff
-
 }

 .platform-tags {
    display: flex;
    flex-wrap: wrap;
+    padding-bottom: 8px;
 }

 .platform-tags > .platform-tag {
    align-self: center;
 }

+.platform-tags > .platform-tag:first-of-type {
+    margin-left: auto;
+}
+
 .platform-tag.jvm-like {
    background-color: #4DBB5F;
    color: white;
@@ -724,16 +736,16 @@ td.content {
    display: flex;
    flex-direction: row;
    padding: 0;
-    justify-content: space-between;
    flex-wrap: wrap;
 }

-.main-subrow > span {
+.main-subrow > div > span {
    display: flex;
    position: relative;
 }

-.main-subrow > span > a {
+.main-subrow > div > span > a, 
+.main-subrow > div > span > span[data-unresolved-link] {
    text-decoration: none;
    font-style: normal;
    font-weight: 600;
@@ -741,7 +753,7 @@ td.content {
    color: #282E34;
 }

-.main-subrow > span > a:hover {
+.main-subrow > div > span > a:hover {
    color: var(--hover-link-color);
 }

@@ -772,6 +784,10 @@ td.content {
    position: relative;
 }

+.inline-flex {
+    display: inline-flex;
+}
+
 .platform-hinted {
    flex: auto;
    display: block;
@@ -849,17 +865,12 @@ td.content {
    top: 0;
 }

-.inner-brief-with-platform-tags {
-    display: block;
-    width: 100%
-}
-
-.brief-with-platform-tags {
+.with-platform-tags {
    display: flex;
 }

-.brief-with-platform-tags ~ .main-subrow {
-    padding-top: 16px;
+.with-platform-tags ~ .main-subrow {
+    padding-top: 8px;
 }

 .cover .with-platform-tabs {
@@ -889,7 +900,7 @@ td.content {
 }

 .table-row .with-platform-tabs .sourceset-depenent-content .brief {
-    padding: 16px;
+    padding: 8px;
    background-color: #f4f4f4;
 }

@@ -1070,6 +1081,15 @@ div.runnablesample {
    margin-bottom: 0.2em;
 }

+.w-100 {
+    width: 100%;
+}
+
+.no-gutters {
+    margin: 0;
+    padding: 0;
+}
+
@media screen and (max-width: 1119px) {
    /* TODO this feels wrong as only is an aproximation of correct solution*/
    .filter-section {
@@ -1132,7 +1152,8 @@ div.runnablesample {
        margin-left: -0.5em;
    }
    #content {
-        padding: 0 var(--mobile-horizontal-spacing-for-content);
+        padding: var(--mobile-horizontal-spacing-for-content);
+        padding-top: 0;
    }
    #sideMenu {
        padding-bottom: 16px;