Skip to content

Commit

Permalink
Updated docs 💡
Browse files Browse the repository at this point in the history
  • Loading branch information
chicio committed Oct 12, 2024
1 parent 9617333 commit 1cab193
Show file tree
Hide file tree
Showing 95 changed files with 509 additions and 342 deletions.
1 change: 1 addition & 0 deletions .ruby-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.2.2
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# Change Log
All changes to ID3TagEditor will be documented in this file.

## [5.0.0](https://github.com/chicio/ID3TagEditor/releases/tag/5.0.0)
Release date: 2024-10-12

#### Added
- Swift 6
- Swift Testing
- All demo now based on new targets and SwiftUI

#### Fixed
- Broken isoLatin1 support on Linux platforms, now fallback to utf-8

## [4.6.0](https://github.com/chicio/ID3TagEditor/releases/tag/4.6.0)
Release date: 2023-04-19

Expand Down
2 changes: 2 additions & 0 deletions ID3TagEditor.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
455CF98B2340C4E1004C880A /* PULL_REQUEST_TEMPLATE.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = PULL_REQUEST_TEMPLATE.md; sourceTree = "<group>"; };
45925B99253B4EB4001C8D4F /* codecov.yml */ = {isa = PBXFileReference; lastKnownFileType = text.yaml; path = codecov.yml; sourceTree = "<group>"; };
45925B9A253B5277001C8D4F /* codecov.yml */ = {isa = PBXFileReference; lastKnownFileType = text.yaml; path = codecov.yml; sourceTree = "<group>"; };
459679DB2CBAE67100F841E7 /* .ruby-version */ = {isa = PBXFileReference; lastKnownFileType = text; path = ".ruby-version"; sourceTree = "<group>"; };
45AB7193204AD842004A2239 /* Package.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Package.swift; sourceTree = "<group>"; };
45AB7194204AD842004A2239 /* LICENSE.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = LICENSE.md; sourceTree = "<group>"; };
45AB7195204AD842004A2239 /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
Expand Down Expand Up @@ -230,6 +231,7 @@
455CF9862340C14B004C880A /* ID3TagEditor.podspec */,
45AB7193204AD842004A2239 /* Package.swift */,
45D4C39A25399ABD00501417 /* .codebeatignore */,
459679DB2CBAE67100F841E7 /* .ruby-version */,
45D4C39C25399ABD00501417 /* .gitignore */,
45D4C39B25399ABD00501417 /* .swiftlint.yml */,
45925B9A253B5277001C8D4F /* codecov.yml */,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"originHash" : "1fa961aa1dc717cea452f3389668f0f99a254f07e4eb11d190768a53798f744f",
"pins" : [
{
"identity" : "swiftlintplugins",
"kind" : "remoteSourceControl",
"location" : "https://github.com/SimplyDanny/SwiftLintPlugins",
"state" : {
"revision" : "7c80ce6f142164b0201871e580b021d1b2c69804",
"version" : "0.57.0"
}
}
],
"version" : 3
}
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2018 Fabrizio Duroni
Copyright (c) 2024 Fabrizio Duroni

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
4 changes: 2 additions & 2 deletions Scripts/generate-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
jazzy \
--output docs \
--module ID3TagEditor \
--xcodebuild-arguments -workspace,ID3TagEditor.xcworkspace,-scheme,"ID3TagEditor iOS" -x USE_SWIFT_RESPONSE_FILE=NO \
--build-tool-arguments -workspace,ID3TagEditor.xcworkspace,-scheme,"ID3TagEditor iOS",-arch,arm64 \
--author_url https://www.fabrizioduroni.it \
--github_url https://github.com/chicio/ID3TagEditor \
--copyright "2020 [Fabrizio Duroni](https://www.fabrizioduroni.it)"
--copyright "2024 [Fabrizio Duroni](https://www.fabrizioduroni.it)"
8 changes: 4 additions & 4 deletions docs/Classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">ID3TagEditor 4.6.0 Docs</a> (100% documented)</p>
<p><a href="index.html">ID3TagEditor 5.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/chicio/ID3TagEditor"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="search.json">
Expand All @@ -28,7 +28,7 @@
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">ID3TagEditor Reference</a>
<a href="index.html">ID3TagEditor</a>
<img id="carat" src="img/carat.png" alt=""/>
Classes Reference
</p>
Expand Down Expand Up @@ -634,8 +634,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>2020 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>2024 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
10 changes: 6 additions & 4 deletions docs/Classes/ID32v2TagBuilder.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ID32v2TagBuilder Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ID3TagEditor 4.6.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">ID3TagEditor 5.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/chicio/ID3TagEditor"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand All @@ -28,7 +28,9 @@
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">ID3TagEditor Reference</a>
<a href="../index.html">ID3TagEditor</a>
<img id="carat" src="../img/carat.png" alt=""/>
<a href="../Classes.html">Classes</a>
<img id="carat" src="../img/carat.png" alt=""/>
ID32v2TagBuilder Class Reference
</p>
Expand Down Expand Up @@ -1628,8 +1630,8 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>2020 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>2024 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
10 changes: 6 additions & 4 deletions docs/Classes/ID32v3TagBuilder.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ID32v3TagBuilder Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ID3TagEditor 4.6.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">ID3TagEditor 5.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/chicio/ID3TagEditor"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand All @@ -28,7 +28,9 @@
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">ID3TagEditor Reference</a>
<a href="../index.html">ID3TagEditor</a>
<img id="carat" src="../img/carat.png" alt=""/>
<a href="../Classes.html">Classes</a>
<img id="carat" src="../img/carat.png" alt=""/>
ID32v3TagBuilder Class Reference
</p>
Expand Down Expand Up @@ -2078,8 +2080,8 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>2020 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>2024 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
10 changes: 6 additions & 4 deletions docs/Classes/ID32v4TagBuilder.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ID32v4TagBuilder Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ID3TagEditor 4.6.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">ID3TagEditor 5.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/chicio/ID3TagEditor"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand All @@ -28,7 +28,9 @@
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">ID3TagEditor Reference</a>
<a href="../index.html">ID3TagEditor</a>
<img id="carat" src="../img/carat.png" alt=""/>
<a href="../Classes.html">Classes</a>
<img id="carat" src="../img/carat.png" alt=""/>
ID32v4TagBuilder Class Reference
</p>
Expand Down Expand Up @@ -1928,8 +1930,8 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>2020 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>2024 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
10 changes: 6 additions & 4 deletions docs/Classes/ID3Frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ID3Frame Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ID3TagEditor 4.6.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">ID3TagEditor 5.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/chicio/ID3TagEditor"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand All @@ -28,7 +28,9 @@
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">ID3TagEditor Reference</a>
<a href="../index.html">ID3TagEditor</a>
<img id="carat" src="../img/carat.png" alt=""/>
<a href="../Classes.html">Classes</a>
<img id="carat" src="../img/carat.png" alt=""/>
ID3Frame Class Reference
</p>
Expand Down Expand Up @@ -231,8 +233,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>2020 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>2024 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
10 changes: 6 additions & 4 deletions docs/Classes/ID3FrameAttachedPicture.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ID3FrameAttachedPicture Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ID3TagEditor 4.6.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">ID3TagEditor 5.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/chicio/ID3TagEditor"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand All @@ -28,7 +28,9 @@
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">ID3TagEditor Reference</a>
<a href="../index.html">ID3TagEditor</a>
<img id="carat" src="../img/carat.png" alt=""/>
<a href="../Classes.html">Classes</a>
<img id="carat" src="../img/carat.png" alt=""/>
ID3FrameAttachedPicture Class Reference
</p>
Expand Down Expand Up @@ -419,8 +421,8 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>2020 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>2024 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
10 changes: 6 additions & 4 deletions docs/Classes/ID3FrameGenre.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ID3FrameGenre Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ID3TagEditor 4.6.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">ID3TagEditor 5.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/chicio/ID3TagEditor"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand All @@ -28,7 +28,9 @@
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">ID3TagEditor Reference</a>
<a href="../index.html">ID3TagEditor</a>
<img id="carat" src="../img/carat.png" alt=""/>
<a href="../Classes.html">Classes</a>
<img id="carat" src="../img/carat.png" alt=""/>
ID3FrameGenre Class Reference
</p>
Expand Down Expand Up @@ -378,8 +380,8 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>2020 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>2024 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
10 changes: 6 additions & 4 deletions docs/Classes/ID3FramePartOfTotal.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ID3FramePartOfTotal Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ID3TagEditor 4.6.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">ID3TagEditor 5.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/chicio/ID3TagEditor"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand All @@ -28,7 +28,9 @@
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">ID3TagEditor Reference</a>
<a href="../index.html">ID3TagEditor</a>
<img id="carat" src="../img/carat.png" alt=""/>
<a href="../Classes.html">Classes</a>
<img id="carat" src="../img/carat.png" alt=""/>
ID3FramePartOfTotal Class Reference
</p>
Expand Down Expand Up @@ -378,8 +380,8 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>2020 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>2024 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
10 changes: 6 additions & 4 deletions docs/Classes/ID3FrameRecordingDateTime.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ID3FrameRecordingDateTime Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ID3TagEditor 4.6.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">ID3TagEditor 5.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/chicio/ID3TagEditor"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand All @@ -28,7 +28,9 @@
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">ID3TagEditor Reference</a>
<a href="../index.html">ID3TagEditor</a>
<img id="carat" src="../img/carat.png" alt=""/>
<a href="../Classes.html">Classes</a>
<img id="carat" src="../img/carat.png" alt=""/>
ID3FrameRecordingDateTime Class Reference
</p>
Expand Down Expand Up @@ -251,8 +253,8 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>2020 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>2024 <a class="link" href="https://www.fabrizioduroni.it" target="_blank" rel="external noopener">Fabrizio Duroni</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</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 1cab193

Please sign in to comment.