wgsldoc 1.0.0-alpha

Documentation generator for WGSL shaders
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

//! Command-line interface module for the documentation generator.
//! Defines the structure for parsing command-line arguments
//! using the `clap` crate.

use clap::Parser;
use std::{env, path::PathBuf};

fn default_name() -> String {
    env::current_dir()
        .ok()
        .and_then(|cwd| cwd.file_name().map(|n| n.to_owned()))
        .and_then(|n| n.to_str().map(|s| s.to_string()))
        .unwrap_or_else(|| "default".to_string())
}

fn default_target() -> PathBuf {
    let mut path = env::current_dir().unwrap_or_else(|_| PathBuf::from("."));
    path.push("docs");
    path
}

#[derive(Parser, Debug, Clone)]
#[command(
    version,
    about = "Documentation generator for WGSL shaders",
    long_about = "wgsldoc is a documentation generator for WGSL (WebGPU Shading Language) shader modules. It parses .wgsl files, extracts documentation comments, and generates a structured, searchable HTML site for easy browsing and reference."
)]
/// Command-line arguments for the documentation generator.
pub struct Args {
    /// Name of the package to generate documentation for.
    #[arg(short = 'N', long, default_value_t = default_name())]
    pub name: String,

    /// Target directory for the generated documentation.
    #[arg(short = 'D', long, default_value_os_t = default_target())]
    pub target_dir: PathBuf,

    /// Base URL for future website. If specified, it will be used to generate links in the documentation.
    /// Otherwise, the links will use `target_dir` as the base URL.
    #[arg(short = 'U', long)]
    pub base_url: Option<String>,

    /// Generate AST and print it to stdout instead of generating full documentation.
    #[arg(short = 'A', long)]
    pub ast_only: bool,

    /// Input files to process.
    /// If not specified, the program will look for .wgsl files in the current directory.
    #[arg(short = 'I', long = "input")]
    pub files: Vec<PathBuf>,

    /// Show undocumented items in the documentation.
    #[arg(short = 'W', long)]
    pub show_undocumented: bool,

    /// Show credits
    #[arg(short = 'C', long)]
    pub credits: bool,
}