diff options
author | Titus Wormer <tituswormer@gmail.com> | 2022-06-13 15:41:26 +0200 |
---|---|---|
committer | Titus Wormer <tituswormer@gmail.com> | 2022-06-13 15:41:26 +0200 |
commit | 06b4ff3531874c95ec07b8440de526795408ef86 (patch) | |
tree | b412e5187d839e2ff9ee2cc4e4c2d743bc5d9cd6 /src/construct/character_reference.rs | |
parent | 4277dac07db06f24ba30a75b4c1dec542e32dae8 (diff) | |
download | markdown-rs-06b4ff3531874c95ec07b8440de526795408ef86.tar.gz markdown-rs-06b4ff3531874c95ec07b8440de526795408ef86.tar.bz2 markdown-rs-06b4ff3531874c95ec07b8440de526795408ef86.zip |
Add some improved docs
Diffstat (limited to 'src/construct/character_reference.rs')
-rw-r--r-- | src/construct/character_reference.rs | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/construct/character_reference.rs b/src/construct/character_reference.rs index 27275d5..943d70f 100644 --- a/src/construct/character_reference.rs +++ b/src/construct/character_reference.rs @@ -1,5 +1,5 @@ -//! Character references are a construct that occurs in the string and text -//! content types. +//! Character references are a construct that occurs in the [string][] and +//! [text][] content types. //! //! They’re formed with the following BNF: //! @@ -45,6 +45,8 @@ //! * [`character-reference.js` in `micromark`](https://github.com/micromark/micromark/blob/main/packages/micromark-core-commonmark/dev/lib/character-reference.js) //! * [*§ 2.5 Entity and numeric character references* in `CommonMark`](https://spec.commonmark.org/0.30/#entity-and-numeric-character-references) //! +//! [string]: crate::content::string +//! [text]: crate::content::text //! [character_escape]: crate::construct::character_reference //! [decode_numeric]: crate::util::decode_numeric_character_reference //! [character_reference_names]: crate::constant::CHARACTER_REFERENCE_NAMES |