Crate doc_chunks

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 Clustering into a CheckableChunk (mostly named just chunk).

CheckableChunks 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
  Chunk definition for what is going to be processed by the checkers
• cluster
  Cluster proc_macro2::Literals into LiteralSets
• errors
• literal
• literalset
• markdown
  Erase cmark syntax
• span
  Span annotation, independent yet compatible with proc_macro2::Span
• testcase
• util

Macros

• chyrp_dbg
  A debug helper to print concatenated length of all items.
• chyrp_up
  A helper macro creating valid doc string using the macro syntax #[doc=r#"..."#].
• fluff_up
  A helper macro creating valid doc string using the macro syntax /// ....

Structs

• Documentation
  Collection of all the documentation entries across the project
• LineColumn
  A line-column pair representing the start or end of a Span.

Functions

• apply_offset
  Apply an offset to start and end members, equaling a shift of the range.

Type Aliases

• Range
  Range based on usize, simplification.