Skip to content

Commit 96e59ed

Browse files
author
Marek Suchánek
committed
Fix the syntax of doc comments
1 parent 44b0740 commit 96e59ed

File tree

4 files changed

+14
-11
lines changed

4 files changed

+14
-11
lines changed

src/cmd_line.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ You should have received a copy of the GNU General Public License
1616
along with this program. If not, see <https://www.gnu.org/licenses/>.
1717
*/
1818

19-
///! # `cmd_line.rs`
20-
///!
21-
///! This module defines the command-line arguments and behavior of `newdoc`.
22-
///! It relies on the `clap` crate.
19+
//! # `cmd_line.rs`
20+
//!
21+
//! This module defines the command-line arguments and behavior of `newdoc`.
22+
//! It relies on the `clap` crate.
2323
use clap::{command, Arg, ArgGroup, ArgMatches};
2424

2525
/// Define the command-line arguments and return them as the `clap::ArgMatches` struct.

src/lib.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,11 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
2828
// Forbid unsafe code in this program.
2929
#![forbid(unsafe_code)]
3030

31-
///! # newdoc
32-
///! The `newdoc` tool generates pre-populated module and assembly files formatted with AsciiDoc,
33-
///! which are used in Red Hat and Fedora documentation. The generated files follow
34-
///! the Modular Documentation guidelines: <https://redhat-documentation.github.io/modular-docs/>.
31+
//! # newdoc
32+
//! The `newdoc` tool generates pre-populated module and assembly files formatted with AsciiDoc,
33+
//! which are used in Red Hat and Fedora documentation. The generated files follow
34+
//! the Modular Documentation guidelines: <https://redhat-documentation.github.io/modular-docs/>.
35+
3536
use clap::ArgMatches;
3637
use color_eyre::eyre::{bail, eyre, Result, WrapErr};
3738

src/module.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ You should have received a copy of the GNU General Public License
1616
along with this program. If not, see <https://www.gnu.org/licenses/>.
1717
*/
1818

19-
/// This module defines the `Module` struct, its builder struct, and methods on both structs.
19+
//! This module defines the `Module` struct, its builder struct, and methods on both structs.
20+
2021
use std::fmt;
2122
use std::path::{Component, Path, PathBuf};
2223

src/validation.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ You should have received a copy of the GNU General Public License
1616
along with this program. If not, see <https://www.gnu.org/licenses/>.
1717
*/
1818

19-
/// This module provides functionality to validate (lint) existing module and assembly files,
20-
/// to check if the files meet the template structure and other requirements.
19+
//! This module provides functionality to validate (lint) existing module and assembly files,
20+
//! to check if the files meet the template structure and other requirements.
21+
2122
use std::ffi::OsStr;
2223
use std::fmt;
2324
use std::fs;

0 commit comments

Comments
 (0)