mirror of
https://github.com/typst/typst
synced 2025-05-17 10:35:28 +08:00
Add minor fixes to doc-comments
This commit is contained in:
parent
f11d28e8ee
commit
6ceb25db82
@ -698,6 +698,10 @@ impl Debug for Items<'_> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// A reference to or a boxed item.
|
/// A reference to or a boxed item.
|
||||||
|
///
|
||||||
|
/// This is conceptually similar to a [`Cow<'a, Item<'a>>`][std::borrow::Cow],
|
||||||
|
/// but we box owned items since an [`Item`] is much bigger than
|
||||||
|
/// a box.
|
||||||
pub enum ItemEntry<'a> {
|
pub enum ItemEntry<'a> {
|
||||||
Ref(&'a Item<'a>),
|
Ref(&'a Item<'a>),
|
||||||
Box(Box<Item<'a>>),
|
Box(Box<Item<'a>>),
|
||||||
|
@ -571,7 +571,7 @@ impl Works {
|
|||||||
|
|
||||||
/// Context for generating the bibliography.
|
/// Context for generating the bibliography.
|
||||||
struct Generator<'a> {
|
struct Generator<'a> {
|
||||||
/// The routines that is used to evaluate mathematical material in citations.
|
/// The routines that are used to evaluate mathematical material in citations.
|
||||||
routines: &'a Routines,
|
routines: &'a Routines,
|
||||||
/// The world that is used to evaluate mathematical material in citations.
|
/// The world that is used to evaluate mathematical material in citations.
|
||||||
world: Tracked<'a, dyn World + 'a>,
|
world: Tracked<'a, dyn World + 'a>,
|
||||||
@ -588,7 +588,7 @@ struct Generator<'a> {
|
|||||||
|
|
||||||
/// Details about a group of merged citations. All citations are put into groups
|
/// Details about a group of merged citations. All citations are put into groups
|
||||||
/// of adjacent ones (e.g., `@foo @bar` will merge into a group of length two).
|
/// of adjacent ones (e.g., `@foo @bar` will merge into a group of length two).
|
||||||
/// Even single citations will be put into groups of length ones.
|
/// Even single citations will be put into groups of length one.
|
||||||
struct GroupInfo {
|
struct GroupInfo {
|
||||||
/// The group's location.
|
/// The group's location.
|
||||||
location: Location,
|
location: Location,
|
||||||
|
Loading…
x
Reference in New Issue
Block a user