googleapis / googleapis/google-cloud-swift

sidekick: generate cross-reference links in documentation comments

Open
#456 1 comment 0 reactions 0 assignees View on GitHub
priority: p2
Dominant language
Swift
Stars
26
Forks
10
Avg merge
12h 56m
Merged PRs (30d)
211

Description

The documentation comments include things like:

```swift
/// Creates a new
/// [ExternalAccountKey][google.cloud.security.publicca.v1.ExternalAccountKey] in
/// a given project.
```

The generator should enrich the comments with reference-style links:

```swift
/// Creates a new
/// [ExternalAccountKey][google.cloud.security.publicca.v1.ExternalAccountKey] in
/// a given project.
///
/// [google.cloud.security.publicca.v1.ExternalAccountKey]: `ExternalAccountKey`
```

*OR* (if this is easier), convert the cross-reference links in place:

```swift
/// Creates a new `ExternalAccountKey` in a given project.
```

The first approach is used by Rust, the second approach is used by Dart.

The first approach is known to work with external types. Maybe the second one does too?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.