Mixing
How to add formatting such as bold, italic, underscore, etc. to Kotlin documenation (KDoc)
I found the page Documenting Kotlin Code in the official Kotlin Reference.
Yet, I could not find out how to highlight certain parts of the documentation, e.g., marking it as italic or bold.
I am new to Kotlin, coming from Java, and have previously only been using JavaDoc, where we used <i> and <b> HTML tags to highlight parts in the documentation.
kotlin formatting code-documentation kdoc
asked Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
add a comment |
I found the page Documenting Kotlin Code in the official Kotlin Reference.
Yet, I could not find out how to highlight certain parts of the documentation, e.g., marking it as italic or bold.
I am new to Kotlin, coming from Java, and have previously only been using JavaDoc, where we used <i> and <b> HTML tags to highlight parts in the documentation.
kotlin formatting code-documentation kdoc
asked Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
add a comment |
I found the page Documenting Kotlin Code in the official Kotlin Reference.
Yet, I could not find out how to highlight certain parts of the documentation, e.g., marking it as italic or bold.
I am new to Kotlin, coming from Java, and have previously only been using JavaDoc, where we used <i> and <b> HTML tags to highlight parts in the documentation.
kotlin formatting code-documentation kdoc
asked Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
I found the page Documenting Kotlin Code in the official Kotlin Reference.
Yet, I could not find out how to highlight certain parts of the documentation, e.g., marking it as italic or bold.
I am new to Kotlin, coming from Java, and have previously only been using JavaDoc, where we used <i> and <b> HTML tags to highlight parts in the documentation.
kotlin formatting code-documentation kdoc
kotlin formatting code-documentation kdoc
asked Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
asked Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
asked Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
asked Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
asked Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
4,49532878
add a comment |
add a comment |
1 Answer
1
active
oldest
votes
As I wrote this question, I found the answer to it.
Silly me, the link I was looking for even was on the page I referenced in the question.
So, I will write an answer to my own question, probably someone else can profit from it in the future.
The documentation states:
Inline Markup
For inline markup, KDoc uses the regular Markdown syntax, extended to support a shorthand syntax for linking to other elements in the code.
So, to highlight a few points of Markdown:
- Markdown treats asterisks (
*) and underscores (_) as indicators of emphasis. Text wrapped with one*or_will be wrapped with an HTML<em>tag; double*’s or_’s will be wrapped with an HTML<strong>tag. Typically, a single asterik results in italic, while double asterik results in bold. - Headers can be started with
#(h1),##(h2), or###(h3). For example:# This is an H1
- Code can be wrapped in backticks
- Quotes start with a right arrow (
>) - Markdown also supports unordered and ordered lists
- ... and more
answered Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
add a comment |
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53413060%2fhow-to-add-formatting-such-as-bold-italic-underscore-etc-to-kotlin-documenat%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
As I wrote this question, I found the answer to it.
Silly me, the link I was looking for even was on the page I referenced in the question.
So, I will write an answer to my own question, probably someone else can profit from it in the future.
The documentation states:
Inline Markup
For inline markup, KDoc uses the regular Markdown syntax, extended to support a shorthand syntax for linking to other elements in the code.
So, to highlight a few points of Markdown:
- Markdown treats asterisks (
*) and underscores (_) as indicators of emphasis. Text wrapped with one*or_will be wrapped with an HTML<em>tag; double*’s or_’s will be wrapped with an HTML<strong>tag. Typically, a single asterik results in italic, while double asterik results in bold. - Headers can be started with
#(h1),##(h2), or###(h3). For example:# This is an H1
- Code can be wrapped in backticks
- Quotes start with a right arrow (
>) - Markdown also supports unordered and ordered lists
- ... and more
answered Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
add a comment |
As I wrote this question, I found the answer to it.
Silly me, the link I was looking for even was on the page I referenced in the question.
So, I will write an answer to my own question, probably someone else can profit from it in the future.
The documentation states:
Inline Markup
For inline markup, KDoc uses the regular Markdown syntax, extended to support a shorthand syntax for linking to other elements in the code.
So, to highlight a few points of Markdown:
- Markdown treats asterisks (
*) and underscores (_) as indicators of emphasis. Text wrapped with one*or_will be wrapped with an HTML<em>tag; double*’s or_’s will be wrapped with an HTML<strong>tag. Typically, a single asterik results in italic, while double asterik results in bold. - Headers can be started with
#(h1),##(h2), or###(h3). For example:# This is an H1
- Code can be wrapped in backticks
- Quotes start with a right arrow (
>) - Markdown also supports unordered and ordered lists
- ... and more
answered Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
add a comment |
As I wrote this question, I found the answer to it.
Silly me, the link I was looking for even was on the page I referenced in the question.
So, I will write an answer to my own question, probably someone else can profit from it in the future.
The documentation states:
Inline Markup
For inline markup, KDoc uses the regular Markdown syntax, extended to support a shorthand syntax for linking to other elements in the code.
So, to highlight a few points of Markdown:
- Markdown treats asterisks (
*) and underscores (_) as indicators of emphasis. Text wrapped with one*or_will be wrapped with an HTML<em>tag; double*’s or_’s will be wrapped with an HTML<strong>tag. Typically, a single asterik results in italic, while double asterik results in bold. - Headers can be started with
#(h1),##(h2), or###(h3). For example:# This is an H1
- Code can be wrapped in backticks
- Quotes start with a right arrow (
>) - Markdown also supports unordered and ordered lists
- ... and more
answered Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
As I wrote this question, I found the answer to it.
Silly me, the link I was looking for even was on the page I referenced in the question.
So, I will write an answer to my own question, probably someone else can profit from it in the future.
The documentation states:
Inline Markup
For inline markup, KDoc uses the regular Markdown syntax, extended to support a shorthand syntax for linking to other elements in the code.
So, to highlight a few points of Markdown:
- Markdown treats asterisks (
*) and underscores (_) as indicators of emphasis. Text wrapped with one*or_will be wrapped with an HTML<em>tag; double*’s or_’s will be wrapped with an HTML<strong>tag. Typically, a single asterik results in italic, while double asterik results in bold. - Headers can be started with
#(h1),##(h2), or###(h3). For example:# This is an H1
- Code can be wrapped in backticks
- Quotes start with a right arrow (
>) - Markdown also supports unordered and ordered lists
- ... and more
answered Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
answered Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
answered Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
answered Nov 21 '18 at 13:25
Markus WeningerMarkus Weninger
4,49532878
4,49532878
add a comment |
add a comment |
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53413060%2fhow-to-add-formatting-such-as-bold-italic-underscore-etc-to-kotlin-documenat%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
