Skip to main content

pharos_runtime_docs/
lib.rs

1#![forbid(unsafe_code)]
2
3/// Exposes the `docs` module.
4///
5/// # Examples
6///
7/// ```rust,ignore
8/// use pharos_runtime_docs::docs;
9/// ```
10///
11/// # Related
12///
13/// - [`crate`] for sibling modules in the same crate.
14pub mod docs;
15/// Exposes the `reference` module.
16///
17/// # Examples
18///
19/// ```rust,ignore
20/// use pharos_runtime_docs::reference;
21/// ```
22///
23/// # Related
24///
25/// - [`crate`] for sibling modules in the same crate.
26pub mod reference;
27
28/// Identifies the optional docs/reference compilation boundary.
29///
30/// # Examples
31///
32/// ```rust,ignore
33/// let _ = pharos_runtime_docs::fn;
34/// ```
35///
36/// # Related
37///
38/// - [`crate`] for the surrounding module surface.
39pub const fn docs_crate_ready() -> bool {
40    true
41}
42pub mod rustdoc;