Skip to content

Commit

Permalink
Improve formatting of doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
TimJentzsch committed Sep 26, 2024
1 parent a343ccb commit 27273e5
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions src/external_cli/cargo/metadata.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,15 @@ where
#[derive(Debug, Deserialize)]
pub struct Metadata {
/// List of all packages in the workspace.
/// It also includes all feature-enabled dependencies unless --no-deps is used.
///
/// It also includes all feature-enabled dependencies unless `--no-deps` is used.
packages: Vec<Package>,
/// List of members of the workspace.
///
/// Each entry is the Package ID for the package.
workspace_members: Option<Vec<String>>,
/// List of default members of the workspace.
///
/// Each entry is the Package ID for the package.
workspace_default_members: Option<Vec<String>>,
/// The absolute path to the build directory where Cargo places its output.
Expand Down Expand Up @@ -74,14 +77,17 @@ pub struct Dependency {
/// The name of the dependency.
name: String,
/// The version requirement for the dependency.
/// Dependencies without a version requirement have a value of "*".
///
/// Dependencies without a version requirement have a value of `*`.
#[serde(default)]
req: VersionReq,
/// The dependency kind.
/// "dev", "build", or null for a normal dependency.
///
/// `"dev"`, `"build"`, or `null` for a normal dependency.
#[serde(default)]
kind: DependencyKind,
/// The file system path for a local path dependency.
///
/// Not present if not a path dependency.
path: Option<PathBuf>,
}
Expand All @@ -101,6 +107,7 @@ pub enum DependencyKind {
pub struct Target {
kind: Vec<TargetKind>,
/// The name of the target.
///
/// For lib targets, dashes will be replaced with underscores.
name: String,
}
Expand Down

0 comments on commit 27273e5

Please sign in to comment.