Skip to content

Commit e6a5b0c

Browse files
authored
chore(docs): cleanup API docs (#1244)
* Modified the jazzy config to use symbol declarations as documentation for all uncommented public symbols, remove documentation coverage metric from the generated docs, add a docset icon, and include build tool settings in the config so they no longer have to be passed on the command line. * Corrected a typo in a documentation comment in Amplify.swift.
1 parent f9ea674 commit e6a5b0c

File tree

3 files changed

+12
-2
lines changed

3 files changed

+12
-2
lines changed

.jazzy.yaml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,19 @@ author: Amazon Web Services
33
github_url: https://github.com/aws-amplify/amplify-ios
44

55
exclude:
6-
- Pods
6+
- Pods
77

88
clean: true
99
skip_undocumented: false
10+
undocumented_text: ""
11+
hide_documentation_coverage: true
1012
sdk: iphone
1113
theme: apple
14+
build_tool_arguments:
15+
- -workspace
16+
- Amplify.xcworkspace
17+
- -scheme
18+
- Amplify
19+
20+
docset_icon: readme-images/amplify-icon.png
21+

Amplify/Amplify.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
/// but clients can access specific plugins by invoking `getPlugin` on a category and issuing methods directly to
1111
/// that plugin.
1212
///
13-
/// - Warning: It is a serious programmer to invoke any of the category APIs (like `Analytics.record()` or
13+
/// - Warning: It is a serious error to invoke any of the category APIs (like `Analytics.record()` or
1414
/// `API.mutate()`) without first registering plugins via `Amplify.add(plugin:)` and configuring Amplify via
1515
/// `Amplify.configure()`. Such access will cause a preconditionFailure.
1616
///

readme-images/amplify-icon.png

1.75 KB
Loading

0 commit comments

Comments
 (0)