Skip to content

Commit

Permalink
Add a blank line after the short summary in doc comments
Browse files Browse the repository at this point in the history
The first *paragraph* is used as the short summary in documentation,
rather than the first *line* which is what the current code assumes.
This makes the generated documentation create the correct short summary.
  • Loading branch information
dburgener committed Aug 27, 2024
1 parent 10d7f14 commit f697bc2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ use error::ErrorItem;
lalrpop_mod!(#[allow(clippy::all)] pub parser);

/// Compile all machines into a single policy
///
/// The list of input files should contain filenames of files containing policy to be
/// compiled.
/// Returns a Result containing either a string of CIL policy which is the compiled result or a
Expand All @@ -64,6 +65,7 @@ pub fn compile_combined(
}

/// Compile a complete machine policy
///
/// The list of input files should contain filenames of files containing policy to be
/// compiled.
/// The list of machine names are the names of the machines to build.
Expand All @@ -79,6 +81,7 @@ pub fn compile_machine_policies(
}

/// Compile all of the machine policies
///
/// The list of input files should contain filenames of files containing policy to be
/// compiled.
/// Returns a Result containing either a string of CIL policy which is the compiled result or a
Expand All @@ -100,6 +103,7 @@ pub fn compile_machine_policies_all(
}

/// Generate a dbus_contexts file
///
/// In the long term, this needs to take information about the policy to use in the generation
/// For now, all we generate is an xml template
pub fn generate_dbus_contexts() -> Result<String, error::CascadeErrors> {
Expand Down
1 change: 1 addition & 0 deletions src/warning.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// SPDX-License-Identifier: MIT

//! Module for Cascade warning support
//!
//! If your function calls a function that adds warnings, first create a
//! Warnings object to store the warnings. Then call inner() on the
//! WithWarnings object returned from the function generating warnings.
Expand Down

0 comments on commit f697bc2

Please sign in to comment.