Lines Matching refs:doc
12 //! 4. [Doc Comments](#doc-comments)
22 #![doc = include_str!("../../examples/demo.rs")]
130 //! Comments](#doc-comments). Explicit attributes take precedence over inferred
144 //! - When not present: [crate `name`](https://doc.rust-lang.org/cargo/reference/manifest.html#the-name-field) (if on [`Parser`][crate::Parser] container), variant name (if on [`Subcommand`][crate::Subcommand] variant)
147 //! - Without `<expr>`: defaults to [crate `version`](https://doc.rust-lang.org/cargo/reference/manifest.html#the-version-field)
150 //! - Without `<expr>`: defaults to [crate `authors`](https://doc.rust-lang.org/cargo/reference/manifest.html#the-authors-field)
152 //! - When not present: [Doc comment summary](#doc-comments)
153 //! - Without `<expr>`: [crate `description`](https://doc.rust-lang.org/cargo/reference/manifest.html#the-description-field) ([`Parser`][crate::Parser] container)
154 //! - **TIP:** When a doc comment is also present, you most likely want to add
155 //! `#[arg(long_about = None)]` to clear the doc comment so only [`about`][crate::Command::about]
158 //! - When not present: [Doc comment](#doc-comments) if there is a blank line, else nothing
159 //! - When present without a value: [Doc comment](#doc-comments)
160 //! - `verbatim_doc_comment`: Minimizes pre-processing when converting doc comments to [`about`][crate::Command::about] / [`long_about`][crate::Command::long_about]
215 //! - When not present: [Doc comment summary](#doc-comments)
217 //! - When not present: [Doc comment](#doc-comments) if there is a blank line, else nothing
218 //! - When present without a value: [Doc comment](#doc-comments)
219 //! - `verbatim_doc_comment`: Minimizes pre-processing when converting doc comments to [`help`][crate::Arg::help] / [`long_help`][crate::Arg::long_help]
265 //! - When not present: [Doc comment summary](#doc-comments)
310 //! For convenience, doc comments can be used instead of raw methods
324 //! **NOTE:** Attributes have priority over doc comments!
326 //! **Top level doc comments always generate `Command::about/long_about` calls!**
329 //! the doc comment. To clear `long_about`, you can use
353 //! A doc comment consists of three parts:
359 //! present, the whole doc comment will be passed to `Command::long_about` /
360 //! `Arg::long_help`. Or in other words, a doc may result in just a `Command::about` /
412 #![doc = include_str!("../../examples/derive_ref/augment_args.rs")]
426 #![doc = include_str!("../../examples/derive_ref/augment_subcommands.rs")]
446 #![doc = include_str!("../../examples/derive_ref/hand_subcommand.rs")]
465 #![doc = include_str!("../../examples/derive_ref/flatten_hand_args.rs")]
476 //! - Always remember to [document](#doc-comments) args and commands with `#![deny(missing_docs)]`
479 #[doc(inline)]