Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Add note about swift-doc vs. swift doc usage #89

Merged
merged 2 commits into from
Apr 20, 2020
Merged

Add note about swift-doc vs. swift doc usage #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4eb762
Add note about swift-doc vs. swift doc usage
mattt Apr 20, 2020
1fc2543
Add changelog entry for swift-doc vs. swift doc in README
mattt Apr 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Changed Home page to display globals for HTML format.
#81 by @kean.
- Changed README to clarify use of `swift-doc` vs. `swift doc`
on the command line.
#89 by @mattt.

### Fixed

Expand Down
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@ $ make install
files
diagram Generates diagram of Swift symbol relationships

> **Note**:
> The `swift` driver provides extensibility through subcommands.
> If you type an unknown subcommand like `swift foo`,
> the system looks for a command called `swift-foo` in your `PATH`.
> This mechanism allows `swift-doc` to be run either directly or as `swift doc`.
#### swift-doc generate

OVERVIEW: Generates Swift documentation
Expand Down