Skip to content

Commit f697bc2

Browse files
committed
Add a blank line after the short summary in doc comments
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.
1 parent 10d7f14 commit f697bc2

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

src/lib.rs

+4
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ use error::ErrorItem;
4545
lalrpop_mod!(#[allow(clippy::all)] pub parser);
4646

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

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

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

102105
/// Generate a dbus_contexts file
106+
///
103107
/// In the long term, this needs to take information about the policy to use in the generation
104108
/// For now, all we generate is an xml template
105109
pub fn generate_dbus_contexts() -> Result<String, error::CascadeErrors> {

src/warning.rs

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
// SPDX-License-Identifier: MIT
33

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

0 commit comments

Comments
 (0)