Skip to content

Commit

Permalink
Fix the syntax of doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
msuchane committed Aug 21, 2022
1 parent 44b0740 commit 96e59ed
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 11 deletions.
8 changes: 4 additions & 4 deletions src/cmd_line.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

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

/// Define the command-line arguments and return them as the `clap::ArgMatches` struct.
Expand Down
9 changes: 5 additions & 4 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,11 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
// Forbid unsafe code in this program.
#![forbid(unsafe_code)]

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

Expand Down
3 changes: 2 additions & 1 deletion src/module.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

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

Expand Down
5 changes: 3 additions & 2 deletions src/validation.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

/// This module provides functionality to validate (lint) existing module and assembly files,
/// to check if the files meet the template structure and other requirements.
//! This module provides functionality to validate (lint) existing module and assembly files,
//! to check if the files meet the template structure and other requirements.
use std::ffi::OsStr;
use std::fmt;
use std::fs;
Expand Down

0 comments on commit 96e59ed

Please sign in to comment.