generate_api_docs

help_probe::api_docs

Function generate_api_docs 

Source 
pub fn generate_api_docs(result: &ProbeResult, format: DocFormat) -> String
Expand description

Generate API documentation from a ProbeResult.

ยงExamples

use help_probe::{api_docs::{generate_api_docs, DocFormat}, model::ProbeResult};

let result = ProbeResult {
    command: "mytool".to_string(),
    args: vec![],
    exit_code: Some(0),
    timed_out: false,
    help_flag_detected: true,
    usage_blocks: vec![],
    options: vec![],
    subcommands: vec![],
    arguments: vec![],
    examples: vec![],
    environment_variables: vec![],
    validation_rules: vec![],
    raw_stdout: String::new(),
    raw_stderr: String::new(),
};

let markdown = generate_api_docs(&result, DocFormat::Markdown);
assert!(markdown.contains("# mytool"));

let html = generate_api_docs(&result, DocFormat::Html);
assert!(html.contains("<!DOCTYPE html>"));