gergely/taskwarrior-2.x
1
0
Fork 0
Code Issues Actions Packages Projects Releases 1 Wiki Activity

Fix formatting of comments in taskchampion.h (#3228)

Browse Source
This commit is contained in:
Dustin J. Mitchell
2023-12-27 20:02:23 -05:00
committed by GitHub
parent bd46b254af
commit e29925155d
2 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
taskchampion/lib/src/lib.rs
View File

@@ -39,18 +39,19 @@ ffizz_header::snippet! {
/// ///
/// # Overview /// # Overview
/// ///
/// This library defines two major types used to interact with the API, that map directly to Rust /// This library defines four major types used to interact with the API, that map directly to Rust
/// types. /// types.
/// ///
/// * TCReplica - see https://docs.rs/taskchampion/latest/taskchampion/struct.Replica.html * TCTask /// * TCReplica - see https://docs.rs/taskchampion/latest/taskchampion/struct.Replica.html
/// - see https://docs.rs/taskchampion/latest/taskchampion/struct.Task.html * TCServer - see /// * TCTask - see https://docs.rs/taskchampion/latest/taskchampion/struct.Task.html
/// https://docs.rs/taskchampion/latest/taskchampion/trait.Server.html * TCWorkingSet - see /// * TCServer - see https://docs.rs/taskchampion/latest/taskchampion/trait.Server.html
/// https://docs.rs/taskchampion/latest/taskchampion/struct.WorkingSet.html /// * TCWorkingSet - see https://docs.rs/taskchampion/latest/taskchampion/struct.WorkingSet.html
/// ///
/// It also defines a few utility types: /// It also defines a few utility types:
/// ///
/// * TCString - a wrapper around both C (NUL-terminated) and Rust (always utf-8) strings. * /// * TCString - a wrapper around both C (NUL-terminated) and Rust (always utf-8) strings.
/// TC…List - a list of objects represented as a C array * see below for the remainder /// * TC…List - a list of objects represented as a C array
/// * see below for the remainder
/// ///
/// # Safety /// # Safety
/// ///

15
taskchampion/lib/taskchampion.h
View File

@@ -7,18 +7,19 @@
// //
// # Overview // # Overview
// //
// This library defines two major types used to interact with the API, that map directly to Rust // This library defines four major types used to interact with the API, that map directly to Rust
// types. // types.
// //
// * TCReplica - see https://docs.rs/taskchampion/latest/taskchampion/struct.Replica.html * TCTask // * TCReplica - see https://docs.rs/taskchampion/latest/taskchampion/struct.Replica.html
// - see https://docs.rs/taskchampion/latest/taskchampion/struct.Task.html * TCServer - see // * TCTask - see https://docs.rs/taskchampion/latest/taskchampion/struct.Task.html
// https://docs.rs/taskchampion/latest/taskchampion/trait.Server.html * TCWorkingSet - see // * TCServer - see https://docs.rs/taskchampion/latest/taskchampion/trait.Server.html
// https://docs.rs/taskchampion/latest/taskchampion/struct.WorkingSet.html // * TCWorkingSet - see https://docs.rs/taskchampion/latest/taskchampion/struct.WorkingSet.html
// //
// It also defines a few utility types: // It also defines a few utility types:
// //
// * TCString - a wrapper around both C (NUL-terminated) and Rust (always utf-8) strings. * // * TCString - a wrapper around both C (NUL-terminated) and Rust (always utf-8) strings.
// TC…List - a list of objects represented as a C array * see below for the remainder // * TC…List - a list of objects represented as a C array
// * see below for the remainder
// //
// # Safety // # Safety
// //