Skip to content
This repository has been archived by the owner on Nov 26, 2020. It is now read-only.

Commit

Permalink
Migrating documentation from cocoadocs to github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
hebertialmeida committed Feb 21, 2019
1 parent 499e3e0 commit 4a9a720
Show file tree
Hide file tree
Showing 92 changed files with 36,110 additions and 7 deletions.
21 changes: 16 additions & 5 deletions .jazzy.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
module_name: FolioReaderKit
author_name: Heberti Almeida
author_url: https://folioreader.com
module: FolioReaderKit
author: Heberti Almeida
author_url: https://twitter.com/hebertialmeida
github_url: https://github.com/FolioReader/FolioReaderKit
root_url: https://folioReader.github.io/FolioReaderKit/
clean: true
output: Documentation
output: docs/
theme: fullwidth
undocumented_text: ""
hide_documentation_coverage: true

podspec: FolioReaderKit.podspec
min_acl: public
# exclude: ["Source/Core/Helpers/*", "Source/Core/Keychain.swift"]

xcodebuild_arguments:
- "-project"
- "FolioReaderKit.xcodeproj"
- "-scheme"
- "FolioReaderKit"
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ class StoryboardFolioReaderContrainer: FolioReaderContainer {
Go to your storyboard file, choose or create the view controller that should present the epub reader. In the identity inspector set StoryboardFolioReaderContrainer as class.

## Documentation
Checkout [Example](/Example) and [API Documentation](http://cocoadocs.org/docsets/FolioReaderKit)
Checkout [Example](/Example) and [API Documentation](https://folioReader.github.io/FolioReaderKit/)

You can always use the header-doc. (use **alt+click** in Xcode)

Expand Down
1 change: 1 addition & 0 deletions Source/EPUBCore/MediaType.swift
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ public struct MediaType: Equatable {

// MARK: - Equatable

/// :nodoc:
public func == (lhs: MediaType, rhs: MediaType) -> Bool {
guard lhs.name == rhs.name else { return false }
guard lhs.defaultExtension == rhs.defaultExtension else { return false }
Expand Down
4 changes: 4 additions & 0 deletions Source/Extensions.swift
Original file line number Diff line number Diff line change
Expand Up @@ -484,6 +484,7 @@ func findHairlineImageViewUnderView(view: UIView?) -> UIImageView? {
return nil
}

/// :nodoc:
extension UINavigationController {

open override var preferredStatusBarStyle : UIStatusBarStyle {
Expand All @@ -506,6 +507,8 @@ extension UINavigationController {
This fixes iOS 9 crash
http://stackoverflow.com/a/32010520/517707
*/

/// :nodoc:
extension UIAlertController {
open override var supportedInterfaceOrientations : UIInterfaceOrientationMask {
return .portrait
Expand All @@ -516,6 +519,7 @@ extension UIAlertController {
}
}

/// :nodoc:
extension Array {

/**
Expand Down
2 changes: 1 addition & 1 deletion Source/Models/Highlight+Helper.swift
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public enum HighlightStyle: Int {
}
}

/// Completion block
/// :nodoc:
public typealias Completion = (_ error: NSError?) -> ()

extension Highlight {
Expand Down
Loading

0 comments on commit 4a9a720

Please sign in to comment.