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

This commit is contained in:
Dustin J. Mitchell 2023-12-27 20:02:23 -05:00 committed by GitHub
parent bd46b254af
commit e29925155d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 14 deletions

View file

@ -7,18 +7,19 @@
//
// # 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.
//
// * TCReplica - see https://docs.rs/taskchampion/latest/taskchampion/struct.Replica.html * TCTask
// - see https://docs.rs/taskchampion/latest/taskchampion/struct.Task.html * TCServer - see
// https://docs.rs/taskchampion/latest/taskchampion/trait.Server.html * TCWorkingSet - see
// https://docs.rs/taskchampion/latest/taskchampion/struct.WorkingSet.html
// * TCReplica - see https://docs.rs/taskchampion/latest/taskchampion/struct.Replica.html
// * TCTask - see https://docs.rs/taskchampion/latest/taskchampion/struct.Task.html
// * TCServer - see https://docs.rs/taskchampion/latest/taskchampion/trait.Server.html
// * TCWorkingSet - see https://docs.rs/taskchampion/latest/taskchampion/struct.WorkingSet.html
//
// It also defines a few utility types:
//
// * 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
// * 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
//
// # Safety
//