code-docs-rs 0.2.0

Use code docs as runtime documentation
Documentation
  • Coverage
  • 50%
    10 out of 20 items documented0 out of 0 items with examples
  • Size
  • Source code size: 56.09 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.87 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 12s Average build duration of successful builds.
  • all releases: 10s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • sandorex/code-docs-rs
    0 0 0
  • crates.io
  • Dependencies
    • —
  • Versions
  • Owners
  • sandorex

code-docs-rs

Rust crate for documenting code with docstring

Basically it saves docstrings written in rust so you can access it in code and modify it if you wish to print to the user up-to-date documentation for config file for example

There are 3 macros in the crate

  1. code_docs_struct for documenting a struct

  2. code_docs_enum for documenting enums (only unit or tuple!)

  3. code_docs_constants for documenting constants

For examples check out the tests, or even read the full source code as it is VERY small