Expand description
Treat source files as articles / narrative documentation
This is the library. If you want to document your example code in rustdoc, see
rsticle-rustdoc.
See the Readme for a general overview.
Structs§
- Convert
Error - Something went wrong during conversion.
- Profile
- A configuration for document extraction.
Constants§
- DASH
- Default profile for languages with
--comments - HASH
- Default profile for languages with
//comments - SEMICOLON
- Default profile for languages with
;comments - SLASH
- Default profile for languages with
//comments
Functions§
- convert
- Streaming conversion (i.e. file to file).
- convert_
str - In-memory (i.e. non-streaming) conversion.