Skip to content

Commit

Permalink
Cleanup documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@Desbeers
Desbeers committed Jun 22, 2024
1 parent 9e4b1fd commit fb5bc86
Show file tree
Hide file tree
Showing 490 changed files with 44,178 additions and 47,607 deletions.
10 changes: 6 additions & 4 deletions .jazzy.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ source_host_files_url: https://github.com/desbeers/Chord-Provider/blob/main

skip_undocumented: true

#exclude: /*/GeneratedAssetSymbols*,/*/resource_bundle_accessor*
exclude: /*/GeneratedAssetSymbols*,/*/resource_bundle_accessor*

#merge_modules: extensions

Expand All @@ -36,9 +36,9 @@ custom_categories:
children:
- ChordProviderApp
- AppDelegate
- ChordProviderSettings
- ChordProviderGeneralOptions
- ChordProviderError
- AppSettings
- AppError
- AlertMessage
- Help

- name: Song structure
Expand Down Expand Up @@ -94,6 +94,8 @@ custom_categories:
- SongFolderView
- ExportSongView
- ExportFolderView
- FileButtonView
- MenuButtonsView
- SettingsView
- PrintSongView
- ChordDefinitionView
Expand Down
16 changes: 14 additions & 2 deletions Chord Provider/General/AlertMessage.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,11 @@ public struct AlertMessage {
self.role = role
self.action = action
}
/// The `Error`
let error: Error
/// The role of the button
let role: ButtonRole?
/// The action for the button
let action: (() -> Void)?
}

Expand All @@ -32,20 +35,25 @@ extension AlertMessage {
/// This to avoid an error:
/// Protocol ‘LocalizedError’ as a type cannot conform to the protocol itself
struct LocalizedAlertError: LocalizedError {
/// The underlying error
let underlyingError: LocalizedError
/// The error description
var errorDescription: String? {
underlyingError.errorDescription
}
/// The recovery suggestion
var recoverySuggestion: String? {
underlyingError.recoverySuggestion
}
/// The failure reason
var failureReason: String? {
underlyingError.failureReason
}
/// The help anchor
var helpAnchor: String? {
underlyingError.helpAnchor
}

/// Init the struct
init?(error: Error?) {
if let localizedError = error as? LocalizedError {
underlyingError = localizedError
Expand All @@ -64,6 +72,7 @@ extension AlertMessage {
/// Create a custom `LocalizedError`
/// - Note: This is to wrap a `NSError` into the modern world
struct LocalizedAlertCustomError: LocalizedError {
/// Init the struct
init(
errorDescription: String? = nil,
recoverySuggestion: String? = nil,
Expand All @@ -75,10 +84,13 @@ extension AlertMessage {
self.failureReason = failureReason
self.helpAnchor = helpAnchor
}

/// The error description
var errorDescription: String?
/// The recovery suggestion
var recoverySuggestion: String?
/// The failure reason
var failureReason: String?
/// The help anchor
var helpAnchor: String?
}
}
Expand Down
6 changes: 5 additions & 1 deletion Chord Provider/General/FileBookmark.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,17 @@ extension FileBookmark {
}

public extension URL {


/// Open an URL in the Finder
func openInFinder() {
NSWorkspace.shared.activateFileViewerSelecting([self])
}
}

public extension URL {

/// Check if an URL exists
/// - Returns: True of false
func exist() -> Bool {
return FileManager.default.fileExists(atPath: self.path(percentEncoded: false))
}
Expand Down
2 changes: 2 additions & 0 deletions Chord Provider/General/SceneState.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ import SwiftlyChordUtilities

// MARK: Export Stuff

/// The URL of the export PDF
var exportURL: URL {
let fileName = "\(song.metaData.artist) - \(song.metaData.title)"
/// Create URLs
Expand All @@ -49,6 +50,7 @@ import SwiftlyChordUtilities

// MARK: Init

/// Init the class
init() {
/// Get the default settings as is used last time
let appSettings = AppSettings.load(id: "Main")
Expand Down
131 changes: 50 additions & 81 deletions Documentation/Chord definitions.html
View file

Large diffs are not rendered by default.

127 changes: 48 additions & 79 deletions Documentation/ChordPro editor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,16 +49,22 @@
<a href="Chord_Provider/Classes/AppDelegate.html">AppDelegate</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Structs/ChordProviderSettings.html">ChordProviderSettings</a>
<a href="Chord_Provider/Structs/AppSettings.html">AppSettings</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Structs/ChordProviderSettings/Position.html">– Position</a>
<a href="Chord_Provider/Enums/AppError.html">AppError</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Structs/ChordProviderGeneralOptions.html">ChordProviderGeneralOptions</a>
<a href="Chord_Provider/Structs/AlertMessage.html">AlertMessage</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Enums/ChordProviderError.html">ChordProviderError</a>
<a href="Chord_Provider/Structs/AlertMessage/LocalizedAlertError.html">– LocalizedAlertError</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Structs/AlertMessage/LocalizedAlertCustomError.html">– LocalizedAlertCustomError</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Structs/AlertMessage/ConfirmButton.html">– ConfirmButton</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Enums/Help.html">Help</a>
Expand Down Expand Up @@ -185,6 +191,9 @@
<li class="nav-group-task">
<a href="Chord_Provider/Structs/ChordProEditor/Coordinator.html">– Coordinator</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Structs/ChordProEditor/LineNumbersView.html">– LineNumbersView</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Structs/ChordProEditor/SelectionState.html">– SelectionState</a>
</li>
Expand All @@ -194,9 +203,6 @@
<li class="nav-group-task">
<a href="Chord_Provider/Structs/ChordProEditor/TextView.html">– TextView</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Structs/ChordProEditor/LineNumbersView.html">– LineNumbersView</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Structs/ChordProEditor/Wrapper.html">– Wrapper</a>
</li>
Expand Down Expand Up @@ -399,6 +405,15 @@
<li class="nav-group-task">
<a href="Chord_Provider/Structs/ExportFolderView.html">ExportFolderView</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Structs/FileButtonView.html">FileButtonView</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Structs/FileButtonView/SelectFileSheet.html">– SelectFileSheet</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Structs/MenuButtonsView.html">MenuButtonsView</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Structs/SettingsView.html">SettingsView</a>
</li>
Expand Down Expand Up @@ -426,22 +441,22 @@
<a href="Chord_Provider/Classes/AppState/RepeatWholeChorusToggle.html">– RepeatWholeChorusToggle</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Classes/AppState/ChordsMenu.html">– ChordsMenu</a>
<a href="Chord_Provider/Classes/SceneState.html">SceneState</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Classes/AppState/ShowChordsButton.html">– ShowChordsButton</a>
<a href="Chord_Provider/Classes/SceneState/ChordsMenu.html">– ChordsMenu</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Classes/AppState/ChordsPositionPicker.html">– ChordsPositionPicker</a>
<a href="Chord_Provider/Classes/SceneState/ShowChordsButton.html">– ShowChordsButton</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Classes/AppState/ChordsAsDiagramToggle.html">– ChordsAsDiagramToggle</a>
<a href="Chord_Provider/Classes/SceneState/ChordsPositionPicker.html">– ChordsPositionPicker</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Classes/AppState/SongPagingPicker.html">– SongPagingPicker</a>
<a href="Chord_Provider/Classes/SceneState/ChordsAsDiagramToggle.html">– ChordsAsDiagramToggle</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Classes/SceneState.html">SceneState</a>
<a href="Chord_Provider/Classes/SceneState/SongPagingPicker.html">– SongPagingPicker</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Classes/SceneState/ScaleSlider.html">– ScaleSlider</a>
Expand Down Expand Up @@ -566,6 +581,20 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other%20Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Chord_Provider/Enums/Cache.html">Cache</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Enums/CustomFile.html">CustomFile</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Enums/FileBookmark.html">FileBookmark</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other%20Extensions.html">Other Extensions</a>
<ul class="nav-group-tasks">
Expand Down Expand Up @@ -597,10 +626,10 @@
<a href="Chord_Provider/Extensions/DeveloperToolsSupport/DeveloperToolsSupport/ImageResource.html">– ImageResource</a>
</li>
<li class="nav-group-task">
<a href="SwiftlyChordUtilities/Extensions/Foundation/Foundation.Bundle.html">Foundation.Bundle</a>
<a href="Chord_Provider/Extensions/Swift/Error.html">Error</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Extensions/SwiftUI/Image.html">Image</a>
<a href="SwiftlyChordUtilities/Extensions/Foundation/Foundation.Bundle.html">Foundation.Bundle</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Extensions/os/Logger.html">Logger</a>
Expand All @@ -611,9 +640,6 @@
<li class="nav-group-task">
<a href="Chord_Provider/Extensions/Foundation/NSAttributedString/Key.html">– Key</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Extensions/AppKit/NSBezierPath.html">NSBezierPath</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Extensions/AppKit/NSFont.html">NSFont</a>
</li>
Expand All @@ -623,9 +649,6 @@
<li class="nav-group-task">
<a href="Chord_Provider/Extensions/Foundation/NSRange.html">NSRange</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Extensions//NSString.html">NSString</a>
</li>
<li class="nav-group-task">
<a href="Other%20Extensions.html#/c:objc(cs)NSTextLayoutFragment">NSTextLayoutFragment</a>
</li>
Expand All @@ -650,9 +673,6 @@
<li class="nav-group-task">
<a href="Chord_Provider/Extensions/Chord_Provider/SWIFTStringAttribute.html">SWIFTStringAttribute</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Extensions/Chord_Provider/SWIFTTextView.html">SWIFTTextView</a>
</li>
<li class="nav-group-task">
<a href="SwiftlyChordUtilities/Extensions/Swift/Sequence.html">Sequence</a>
</li>
Expand All @@ -669,10 +689,7 @@
<a href="Chord_Provider/Extensions/SwiftUI/SwiftUI/ShapeStyle.html">– ShapeStyle</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Extensions//UIColor.html">UIColor</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Extensions//UITextView.html">UITextView</a>
<a href="Chord_Provider/Extensions/Foundation/URL.html">URL</a>
</li>
<li class="nav-group-task">
<a href="Chord_Provider/Extensions/UniformTypeIdentifiers/UTType.html">UTType</a>
Expand All @@ -685,57 +702,9 @@
<li class="nav-group-name">
<a href="Other%20Typealiases.html">Other Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/SWIFTBezierPath">SWIFTBezierPath</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/s:14Chord_Provider15SWIFTBezierPatha">SWIFTBezierPath</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/SWIFTColor">SWIFTColor</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/s:14Chord_Provider10SWIFTColora">SWIFTColor</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/SWIFTEdgeInsets">SWIFTEdgeInsets</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/s:14Chord_Provider15SWIFTEdgeInsetsa">SWIFTEdgeInsets</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/SWIFTFont">SWIFTFont</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/s:14Chord_Provider9SWIFTFonta">SWIFTFont</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/SWIFTImage">SWIFTImage</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/s:14Chord_Provider10SWIFTImagea">SWIFTImage</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/s:14Chord_Provider20SWIFTStringAttributea">SWIFTStringAttribute</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/SWIFTTextView">SWIFTTextView</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/s:14Chord_Provider13SWIFTTextViewa">SWIFTTextView</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/SWIFTTextViewDelegate">SWIFTTextViewDelegate</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/s:14Chord_Provider21SWIFTTextViewDelegatea">SWIFTTextViewDelegate</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/SWIFTViewRepresentable">SWIFTViewRepresentable</a>
</li>
<li class="nav-group-task">
<a href="Other%20Typealiases.html#/s:14Chord_Provider22SWIFTViewRepresentablea">SWIFTViewRepresentable</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -770,12 +739,12 @@ <h1>ChordPro editor</h1>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">ChordProEditor</span> <span class="p">:</span> <span class="kt"><a href="Other%20Typealiases.html#/s:14Chord_Provider22SWIFTViewRepresentablea">SWIFTViewRepresentable</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">ChordProEditor</span><span class="p">:</span> <span class="kt">NSViewRepresentable</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/desbeers/Chord-Provider/blob/main/Chord Provider/ChordProEditor/ChordProEditor.swift#L11-L76">Show on GitHub</a>
<a href="https://github.com/desbeers/Chord-Provider/blob/main/Chord Provider/ChordProEditor/ChordProEditor.swift#L11-L52">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -817,7 +786,7 @@ <h4>Declaration</h4>
</section>
<section id="footer">
<p>© 2024 Nick Berendsen</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
Loading

0 comments on commit fb5bc86

Please sign in to comment.