Crate doc_chunks
source · [−]Expand description
Doc Chunks
Documentation
is a representation of one or multiple documents.
A literal
is a token provided by proc_macro2
or ra_ap_syntax
crate, which is then converted by
means of TrimmedLiteral
using Cluster
ing into a CheckableChunk
(mostly
named just chunk
).
CheckableChunk
s can consist of multiple fragments, where each fragment can
span multiple lines, yet each fragment is covering a consecutive Span
in
the origin content. Each fragment also has a direct mapping to the
CheckableChunk
internal string representation.
And Documentation
holds one or many CheckableChunks
per file path.
Re-exports
pub use self::span::Span;
pub use chunk::*;
pub use cluster::*;
pub use errors::*;
pub use literal::*;
pub use literalset::*;
pub use markdown::*;
Modules
Chunk definition for what is going to be processed by the checkers
Cluster proc_macro2::Literal
s into LiteralSets
Erase cmark syntax
Span
annotation, independent yet compatible with proc_macro2::Span
Macros
A debug helper to print concatenated length of all items.
A helper macro creating valid doc string using the macro syntax
#[doc=r#"..."#]
.
A helper macro creating valid doc string using the macro syntax
/// ...
.
Structs
Collection of all the documentation entries across the project
A line-column pair representing the start or end of a Span
.
Functions
Apply an offset to start
and end
members, equaling a shift of the range.
Type Definitions
Range based on usize
, simplification.