[docs] Update docs for Cephei 1.17

hbang · Jul 31, 2021 · e1aeb45 · e1aeb45
1 parent d93427a
commit e1aeb45
Show file tree

Hide file tree

Showing 68 changed files with 6,776 additions and 7,806 deletions.
diff --git a/.jazzy.yaml b/.jazzy.yaml
@@ -1,6 +1,4 @@
 clean: true
-output: docs
-theme: fullwidth
 objc: true
 sdk: iphonesimulator
 module: Cephei
@@ -11,7 +9,6 @@ author_url: https://hbang.github.io/
 github_url: https://github.com/hbang/libcephei
 root_url: https://hbang.github.io/libcephei/
 dash_url: https://hbang.github.io/libcephei/docsets/Cephei.xml
-readme: README.md
 documentation: info/*.md
 exclude: "*/include/*"
 hide_documentation_coverage: true

diff --git a/HBPreferences.h b/HBPreferences.h
@@ -68,12 +68,11 @@ typedef void (^HBPreferencesValueChangeCallback)(NSString *key, id<NSCopying> _N
 /// 	private let preferences = HBPreferences(identifier: "ws.hbang.common.demo")
 ///
 /// 	// Example using registration method
-/// 	private(set) var isEnabled: Bool = false
-/// 	private(set) var canDoThing: Bool = false
+/// 	private(set) var canDoThing: ObjCBool = false
 ///
 /// 	// Example using custom getter and setter
 /// 	var anotherSetting: Int {
-/// 		get { preferences["AnotherSetting"] as! Int }
+/// 		get { preferences["AnotherSetting"] as? Int ?? -1 }
 /// 		set { preferences["AnotherSetting"] = newValue }
 /// 	}
 ///
@@ -86,11 +85,10 @@ typedef void (^HBPreferencesValueChangeCallback)(NSString *key, id<NSCopying> _N
 /// 			"AnotherSetting": 1
 /// 		])
 ///
-/// 		preferences.register(&isEnabled, default: true, forKey: "Enabled")
-/// 		preferences.register(&canDoThing, default: false, forKey: "Enabled")
+/// 		preferences.register(&canDoThing, default: false, forKey: "DoThing")
 ///
-/// 		// Example using dictionary subscript methods
 /// 		print("Am I enabled? \(preferences["Enabled"] as? Bool ?? false)")
+/// 		print("Can I do thing? \(canDoThing)")
 /// 	}
 ///
 /// }

diff --git a/docs/Categories/NSDictionary(HBAdditions).html b/docs/Categories/NSDictionary(HBAdditions).html
diff --git a/docs/Categories/NSLayoutConstraint(CompactConstraint).html b/docs/Categories/NSLayoutConstraint(CompactConstraint).html
diff --git a/docs/Categories/NSString(HBAdditions).html b/docs/Categories/NSString(HBAdditions).html
diff --git a/docs/Categories/PSListController(HBTintAdditions).html b/docs/Categories/PSListController(HBTintAdditions).html
diff --git a/docs/Categories/UIColor(HBAdditions).html b/docs/Categories/UIColor(HBAdditions).html
diff --git a/docs/Categories/UIView(CompactConstraint).html b/docs/Categories/UIView(CompactConstraint).html
diff --git a/docs/Cephei — General.html b/docs/Cephei — General.html
diff --git a/docs/Cephei — Types and Constants.html b/docs/Cephei — Types and Constants.html
diff --git a/docs/CepheiPrefs — Cells.html b/docs/CepheiPrefs — Cells.html
diff --git a/docs/CepheiPrefs — Deprecated.html b/docs/CepheiPrefs — Deprecated.html
diff --git a/docs/CepheiPrefs — General.html b/docs/CepheiPrefs — General.html
diff --git a/docs/CepheiPrefs — List Controllers.html b/docs/CepheiPrefs — List Controllers.html
diff --git a/docs/CepheiUI — General.html b/docs/CepheiUI — General.html
diff --git a/docs/Classes/HBAboutListController.html b/docs/Classes/HBAboutListController.html
diff --git a/docs/Classes/HBAppearanceSettings.html b/docs/Classes/HBAppearanceSettings.html
diff --git a/docs/Classes/HBDiscreteSliderTableCell.html b/docs/Classes/HBDiscreteSliderTableCell.html
diff --git a/docs/Classes/HBLinkTableCell.html b/docs/Classes/HBLinkTableCell.html
diff --git a/docs/Classes/HBListController.html b/docs/Classes/HBListController.html
diff --git a/docs/Classes/HBPreferences.html b/docs/Classes/HBPreferences.html
diff --git a/docs/Classes/HBRespringController.html b/docs/Classes/HBRespringController.html
diff --git a/docs/Classes/HBRootListController.html b/docs/Classes/HBRootListController.html
diff --git a/docs/Classes/HBStepperTableCell.html b/docs/Classes/HBStepperTableCell.html
diff --git a/docs/Classes/HBSupportController.html b/docs/Classes/HBSupportController.html
diff --git a/docs/Enums/HBAppearanceSettingsLargeTitleStyle.html b/docs/Enums/HBAppearanceSettingsLargeTitleStyle.html
diff --git a/docs/cepheiprefs-annoying-warning.html b/docs/cepheiprefs-annoying-warning.html
diff --git a/docs/container-support.html b/docs/container-support.html