Crate clidoc

source ·
Expand description

Clidoc generates documentation for host tool commands consisting of their –help output.

Structs

Opt 🔒
CliDoc generates documentation for core Fuchsia developer tools.

Enums

HelpError 🔒

Constants

Statics

CALLSITE 🔒
CALLSITE 🔒
CALLSITE 🔒
CALLSITE 🔒
CALLSITE 🔒
CALLSITE 🔒
CALLSITE 🔒
CALLSITE 🔒
CALLSITE 🔒
CALLSITE 🔒
CALLSITE 🔒
CALLSITE 🔒
CALLSITE 🔒
CALLSITE 🔒
LAZY 🔒
META 🔒
META 🔒
META 🔒
META 🔒
META 🔒
META 🔒
META 🔒
META 🔒
META 🔒
META 🔒
META 🔒
META 🔒
META 🔒
META 🔒

Functions

Create the output dir if doesn’t exist, recursively creating subdirs in path.
Generate a vector of full paths to each command in the allow_list.
Get cmd –help output when given a full path to a cmd.
main 🔒
md_path 🔒
Given a cmd name and a dir, create a full path ending in cmd.md.
Helper function for write_formatted_output.
run 🔒
Write output of cmd at cmd_path to new cmd.md file at output_path.