diff options
author | Titus Wormer <tituswormer@gmail.com> | 2022-06-28 15:15:26 +0200 |
---|---|---|
committer | Titus Wormer <tituswormer@gmail.com> | 2022-06-28 15:15:26 +0200 |
commit | e9db93b428bc3da7c1fa3bcf8acf166012cf18c8 (patch) | |
tree | f3998ce57afcd1c148967713899436a4213a6ca7 | |
parent | 769e7011d37a2ad54630aeebdb0b0163a0825f75 (diff) | |
download | markdown-rs-e9db93b428bc3da7c1fa3bcf8acf166012cf18c8.tar.gz markdown-rs-e9db93b428bc3da7c1fa3bcf8acf166012cf18c8.tar.bz2 markdown-rs-e9db93b428bc3da7c1fa3bcf8acf166012cf18c8.zip |
Add docs for label start (image, link)
Diffstat (limited to '')
-rw-r--r-- | readme.md | 2 | ||||
-rw-r--r-- | src/construct/label_start_image.rs | 31 | ||||
-rw-r--r-- | src/construct/label_start_link.rs | 30 |
3 files changed, 60 insertions, 3 deletions
@@ -124,7 +124,6 @@ cargo doc --document-private-items #### Docs -- [ ] (1) `label_start_image`, `label_start_link` - [ ] (1) `label_end` - [ ] (1) `space_or_tab_one_line_ending` - [ ] (1) `ParseState` @@ -284,3 +283,4 @@ important. - [x] (1) Add module docs to parser - [x] (1) Add improved docs in compiler - [x] (1) Add docs for `RESOURCE_DESTINATION_BALANCE_MAX` +- [x] (1) Add docs for `label_start_image`, `label_start_link` diff --git a/src/construct/label_start_image.rs b/src/construct/label_start_image.rs index 2e96977..97231e0 100644 --- a/src/construct/label_start_image.rs +++ b/src/construct/label_start_image.rs @@ -1,4 +1,33 @@ -//! To do +//! Label start (image) is a construct that occurs in the [text][] content +//! type. +//! +//! It forms with the following BNF: +//! +//! ```bnf +//! label_start_image ::= '!' '[' +//! ``` +//! +//! Label start (images) relates to the `<img>` element in HTML. +//! See [*§ 4.8.3 The `img` element*][html-img] in the HTML spec for more info. +//! +//! Whether it contributes an image depends on whether it is followed by a +//! valid [label end][label_end] or not. +//! Without an end, the characters (`![`) are output. +//! +//! ## Tokens +//! +//! * [`LabelImage`][TokenType::LabelImage] +//! * [`LabelImageMarker`][TokenType::LabelImageMarker] +//! * [`LabelMarker`][TokenType::LabelMarker] +//! +//! ## References +//! +//! * [`label-start-image.js` in `micromark`](https://github.com/micromark/micromark/blob/main/packages/micromark-core-commonmark/dev/lib/label-start-image.js) +//! * [*§ 6.4 Images* in `CommonMark`](https://spec.commonmark.org/0.30/#images) +//! +//! [text]: crate::content::text +//! [label_end]: crate::construct::label_end +//! [html-img]: https://html.spec.whatwg.org/multipage/embedded-content.html#the-img-element use super::label_end::resolve_media; use crate::tokenizer::{Code, LabelStart, State, StateFnResult, TokenType, Tokenizer}; diff --git a/src/construct/label_start_link.rs b/src/construct/label_start_link.rs index 35c9dcd..677fb50 100644 --- a/src/construct/label_start_link.rs +++ b/src/construct/label_start_link.rs @@ -1,4 +1,32 @@ -//! To do +//! Label start (link) is a construct that occurs in the [text][] content +//! type. +//! +//! It forms with the following BNF: +//! +//! ```bnf +//! label_start_link ::= '[' +//! ``` +//! +//! Label start (link) relates to the `<a>` element in HTML. +//! See [*§ 4.5.1 The `a` element*][html-a] in the HTML spec for more info. +//! +//! Whether it contributes a link depends on whether it is followed by a +//! valid [label end][label_end] or not. +//! Without an end, the characters (`[`) are output. +//! +//! ## Tokens +//! +//! * [`LabelLink`][TokenType::LabelLink] +//! * [`LabelMarker`][TokenType::LabelMarker] +//! +//! ## References +//! +//! * [`label-start-link.js` in `micromark`](https://github.com/micromark/micromark/blob/main/packages/micromark-core-commonmark/dev/lib/label-start-link.js) +//! * [*§ 6.3 Links* in `CommonMark`](https://spec.commonmark.org/0.30/#links) +//! +//! [text]: crate::content::text +//! [label_end]: crate::construct::label_end +//! [html-a]: https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-a-element use super::label_end::resolve_media; use crate::tokenizer::{Code, LabelStart, State, StateFnResult, TokenType, Tokenizer}; |