Updated doc 💡

chicio · Aug 5, 2018 · 5f84f46 · 5f84f46
1 parent f292fd7
commit 5f84f46
Show file tree

Hide file tree

Showing 44 changed files with 362 additions and 991 deletions.
diff --git a/Source/Tag/ID3Genre.swift b/Source/Tag/ID3Genre.swift
@@ -11,87 +11,169 @@ import Foundation
  An enum that contains the genres supported by the ID3 standard using specific identifiers.
  */
 public enum ID3Genre: Int, Equatable {
+    /// Blues genre.
     case Blues = 0
+    /// Classic rock genre.
     case ClassicRock = 1
+    /// Country genre.
     case Country = 2
+    /// Dance genre.
     case Dance = 3
+    /// Disco genre.
     case Disco = 4
+    /// Funk genre.
     case Funk = 5
+    /// Grunge genre.
     case Grunge = 6
+    /// Hip hop genre.
     case HipHop = 7
+    /// Jazz genre.
     case Jazz = 8
+    /// Metal genre.
     case Metal = 9
+    /// New age genre.
     case NewAge = 10
+    /// Oldies genre.
     case Oldies = 11
+    /// Other genre.
     case Other = 12
+    /// Pop genre.
     case Pop = 13
+    /// R&B genre.
     case RAndB = 14
+    /// Rap genre.
     case Rap = 15
+    /// Reggae genre.
     case Reggae = 16
+    /// Rock genre.
     case Rock = 17
+    /// Techno genre.
     case Techno = 18
+    /// Industrial genre.
     case Industrial = 19
+    /// Alternative genre.
     case Alternative = 20
+    /// Ska genre.
     case Ska = 21
+    /// Death metal genre.
     case DeathMetal = 22
+    /// Pranks genre.
     case Pranks = 23
+    /// Soundtrack genre.
     case Soundtrack = 24
+    /// Euro techno genre.
     case EuroTechno = 25
+    /// Ambient genre.
     case Ambient = 26
+    /// Tip hop genre.
     case TripHop = 27
+    /// vocal genre.
     case Vocal = 28
+    /// Jazz funk genre.
     case JazzFunk = 29
+    /// Fusion genre.
     case Fusion = 30
+    /// Trance genre.
     case Trance = 31
+    /// Classical genre.
     case Classical = 32
+    /// Instrumental genre.
     case Instrumental = 33
+    /// Acid genre.
     case Acid = 34
+    /// House genre.
     case House = 35
+    /// Game genre.
     case Game = 36
+    /// Soundclip genre.
     case SoundClip = 37
+    /// Gospel genre.
     case Gospel = 38
+    /// Noise genre.
     case Noise = 39
+    /// Altern rock genre.
     case AlternRock = 40
+    /// Bass genre.
     case Bass = 41
+    /// Soul genre.
     case Soul = 42
+    /// Punk genre.
     case Punk = 43
+    /// Space genre.
     case Space = 44
+    /// Meditative genre.
     case Meditative = 45
+    /// Instrumental pop genre.
     case InstrumentalPop = 46
+    /// Instrumental rock genre.
     case InstrumentalRock = 47
+    /// Ethnic genre.
     case Ethnic = 48
+    /// Gothic genre.
     case Gothic = 49
+    /// Darkwave genre.
     case Darkwave = 50
+    /// TechnoIndustrial genre.
     case TechnoIndustrial = 51
+    /// Electronic genre.
     case Electronic = 52
+    /// Pop folk genre.
     case PopFolk = 53
+    /// Eurodance genre.
     case Eurodance = 54
+    /// Dream genre.
     case Dream = 55
+    /// Souther rock genre.
     case SouthernRock = 56
+    /// Comedy genre.
     case Comedy = 57
+    /// Cult genre.
     case Cult = 58
+    /// Gangsta genre.
     case Gangsta = 59
+    /// Top 40 genre.
     case Top40 = 60
+    /// Christian rap genre.
     case ChristianRap = 61
+    /// Pop funk genre.
     case PopFunk = 62
+    /// Jungle genre.
     case Jungle = 63
+    /// Native american genre.
     case NativeAmerican = 64
+    /// Cabaret genre.
     case Cabaret = 65
+    /// New wave genre.
     case NewWave = 66
+    /// Psychadelic genre.
     case Psychadelic = 67
+    /// Rave genre.
     case Rave = 68
+    /// Showtunes genre.
     case Showtunes = 69
+    /// Trailer genre.
     case Trailer = 70
+    /// Lofi genre.
     case LoFi = 71
+    /// Tribal genre.
     case Tribal = 72
+    /// Acid punk genre.
     case AcidPunk = 73
+    /// Acid jazz genre.
     case AcidJazz = 74
+    /// Polka genre.
     case Polka = 75
+    /// Retro genre.
     case Retro = 76
+    /// Musical genre.
     case Musical = 77
+    /// Rock and roll genre.
     case RockAndRoll = 78
+    /// Hard rock genre.
     case HardRock = 79
+    /// Remix genre.
     case Remix = 80
+    /// Cover genre.
     case Cover = 81
 
     /**

diff --git a/Source/Tag/ID3PictureFormat.swift b/Source/Tag/ID3PictureFormat.swift
@@ -11,6 +11,8 @@ import Foundation
  The attached picture format supported by the ID3 tag.
  */
 public enum ID3PictureFormat {
+    /// Jpeg image.
     case Jpeg
+    /// Png image.
     case Png
 }
diff --git a/Source/Tag/ID3PictureType.swift b/Source/Tag/ID3PictureType.swift
@@ -11,26 +11,47 @@ import Foundation
  An enum that describes the ID3 picture type supported.
  */
 public enum ID3PictureType: UInt8, Equatable {
+    /// Other image.
     case Other = 0x00
+    /// File icon image.
     case fileIcon = 0x01
+    /// Other file icon image.
     case OtherFileIcon = 0x02
+    /// Front cover image.
     case FrontCover = 0x03
+    /// Back cover image.
     case BackCover = 0x04
+    /// LeafketPage image.
     case LeafletPage = 0x05
+    /// Media image.
     case Media = 0x06
+    /// Lead artist image image.
     case LeadArtistLeadPerformerSoloist = 0x07
+    /// Artist image image.
     case ArtistPerformer = 0x08
+    /// Conductor image.
     case Conductor = 0x09
+    /// Orchestra/band image.
     case BandOrchestra = 0x0A
+    /// Composer image.
     case Composer = 0x0B
+    /// Lyricist Text Writer image.
     case LyricistTextWriter = 0x0C
+    /// Recording location image.
     case RecordingLocation = 0x0D
+    /// During recording image.
     case DuringRecording = 0x0E
+    /// Performance image.
     case DuringPerformance = 0x0F
+    /// Movie image.
     case MovieVideoScreenCapture = 0x10
+    /// ABrightColouredFish image.
     case ABrightColouredFish = 0x11
+    /// Illustration image.
     case Illustration = 0x12
+    /// Band logo image.
     case BandArtistLogotype = 0x13
+    /// Publisher logo image.
     case PublisherStudioLogotype = 0x14
 
     /**

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -14,7 +14,7 @@
     <a title="Classes  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html">ID3TagEditor Docs</a> (36% documented)</p>
+        <p><a href="index.html">ID3TagEditor Docs</a> (100% documented)</p>
       </div>
     </header>
     <div class="content-wrapper">

diff --git a/docs/Classes/ID3Tag.html b/docs/Classes/ID3Tag.html
@@ -14,7 +14,7 @@
     <a title="ID3Tag Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">ID3TagEditor Docs</a> (36% documented)</p>
+        <p><a href="../index.html">ID3TagEditor Docs</a> (100% documented)</p>
       </div>
     </header>
     <div class="content-wrapper">

diff --git a/docs/Classes/ID3TagEditor.html b/docs/Classes/ID3TagEditor.html
@@ -14,7 +14,7 @@
     <a title="ID3TagEditor Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">ID3TagEditor Docs</a> (36% documented)</p>
+        <p><a href="../index.html">ID3TagEditor Docs</a> (100% documented)</p>
       </div>
     </header>
     <div class="content-wrapper">

diff --git a/docs/Enums.html b/docs/Enums.html
@@ -14,7 +14,7 @@
     <a title="Enumerations  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html">ID3TagEditor Docs</a> (36% documented)</p>
+        <p><a href="index.html">ID3TagEditor Docs</a> (100% documented)</p>
       </div>
     </header>
     <div class="content-wrapper">