Rustdoc

#![feature(rustc_private)]

use std::process::ExitCode;

fn main() -> ExitCode {
    rustdoc::main()
}

[package]
name = "rustdoc-tool"
version = "0.0.0"
edition = "2024"

# The binary is named differently to avoid conflicts
[[bin]]
name = "rustdoc_tool_binary"
path = "main.rs"

[dependencies]
rustdoc = { path = "../../librustdoc" }

[features]
jemalloc = ['rustdoc/jemalloc']

/// This is a doc comment for the following item.
/// It supports **Markdown** formatting.
///
/// # Examples
///
/// ```
/// let x = my_function(5);
/// assert_eq!(x, 10);
/// ```
pub fn my_function(n: i32) -> i32 {
    n * 2
}

//! This is a doc comment for the containing module.
//! It appears at the top of module documentation.

// Regular code follows...

# Generate documentation for your package
cargo doc

# Generate and open in browser
cargo doc --open

# Include private items
cargo doc --document-private-items

# Generate docs for a specific crate
rustdoc src/lib.rs

# With custom output directory
rustdoc src/lib.rs --out-dir ./docs

# Generate JSON output
rustdoc src/lib.rs --output-format json

cargo doc --no-deps  # Only document this crate
cargo doc            # Document with dependencies

#[doc(hidden)]  // Hide from documentation
pub fn internal_function() {}

#[doc(inline)]  // Inline documentation from re-exports
pub use other_crate::SomeType;

#[doc = include_str!("../README.md")]  // Include external file
pub struct MyStruct;

rustdoc src/lib.rs --extend-css custom.css

rustdoc src/lib.rs -Z unstable-options --output-format json

# Run all doc tests
cargo test --doc

# Test specific doc tests
cargo test --doc specific_function