Skip to content
This repository has been archived by the owner on Feb 9, 2021. It is now read-only.

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew Hyatt committed Mar 6, 2018
1 parent e87d01f commit 3a60da8
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 42 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.build
build
M4ATools.xcodeproj
16 changes: 8 additions & 8 deletions docs/badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 2 additions & 16 deletions docs/docsets/.docset/Contents/Resources/Documents/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<a title=" Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (100% documented)</p>
<p><a href="index.html"> Docs</a> (0% documented)</p>
</div>
</header>
<div class="content-wrapper">
Expand All @@ -26,20 +26,6 @@
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/M4AFile.html">M4AFile</a>
</li>
<li class="nav-group-task">
<a href="Classes/M4AFile/M4AFileError.html">– M4AFileError</a>
</li>
<li class="nav-group-task">
<a href="Classes/M4AFile/Metadata.html">– Metadata</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
Expand All @@ -53,7 +39,7 @@ <h1 id='m4atools' class='heading'>M4ATools</h1>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-14)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-03-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"Classes/M4AFile/Metadata/ImageMetadata.html#/s:8M4ATools0A5AFileC8MetadataO05ImageD0O7artworkA2GmF":{"name":"artwork","abstract":"<p>Artwork</p>","parent_name":"ImageMetadata"},"Classes/M4AFile/Metadata/TwoIntMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06TwoIntD0O5trackA2GmF":{"name":"track","abstract":"<p>Track</p>","parent_name":"TwoIntMetadata"},"Classes/M4AFile/Metadata/TwoIntMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06TwoIntD0O4diskA2GmF":{"name":"disk","abstract":"<p>Disk</p>","parent_name":"TwoIntMetadata"},"Classes/M4AFile/Metadata/IntMetadata.html#/s:8M4ATools0A5AFileC8MetadataO03IntD0O7genreIDA2GmF":{"name":"genreID","abstract":"<p>Genre ID</p>","parent_name":"IntMetadata"},"Classes/M4AFile/Metadata/IntMetadata.html#/s:8M4ATools0A5AFileC8MetadataO03IntD0O3bpmA2GmF":{"name":"bpm","abstract":"<p>BPM</p>","parent_name":"IntMetadata"},"Classes/M4AFile/Metadata/IntMetadata.html#/s:8M4ATools0A5AFileC8MetadataO03IntD0O6ratingA2GmF":{"name":"rating","abstract":"<p>Rating</p>","parent_name":"IntMetadata"},"Classes/M4AFile/Metadata/IntMetadata.html#/s:8M4ATools0A5AFileC8MetadataO03IntD0O7gaplessA2GmF":{"name":"gapless","abstract":"<p>Gapless</p>","parent_name":"IntMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O5albumA2GmF":{"name":"album","abstract":"<p>Album</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O6artistA2GmF":{"name":"artist","abstract":"<p>Artist</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O11albumArtistA2GmF":{"name":"albumArtist","abstract":"<p>Album Artist</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O7commentA2GmF":{"name":"comment","abstract":"<p>Comment</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O4yearA2GmF":{"name":"year","abstract":"<p>Year</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O5titleA2GmF":{"name":"title","abstract":"<p>Title</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O11genreCustomA2GmF":{"name":"genreCustom","abstract":"<p>Custom Genre</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O8composerA2GmF":{"name":"composer","abstract":"<p>Composer</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O7encoderA2GmF":{"name":"encoder","abstract":"<p>Encoder</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O9copyrightA2GmF":{"name":"copyright","abstract":"<p>Copyright</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O11compilationA2GmF":{"name":"compilation","abstract":"<p>Compilation</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O6lyricsA2GmF":{"name":"lyrics","abstract":"<p>Lyrics</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O12purchaseDateA2GmF":{"name":"purchaseDate","abstract":"<p>Purchase Date</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O8groupingA2GmF":{"name":"grouping","abstract":"<p>Grouping</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O4miscA2GmF":{"name":"misc","abstract":"<p>Unknown, can be ignored</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O12sortingAlbumA2GmF":{"name":"sortingAlbum","abstract":"<p>Sorting album</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O13sortingArtistA2GmF":{"name":"sortingArtist","abstract":"<p>Sorting artist</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O18sortingAlbumArtistA2GmF":{"name":"sortingAlbumArtist","abstract":"<p>Sorting album artist</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html#/s:8M4ATools0A5AFileC8MetadataO06StringD0O15sortingComposerA2GmF":{"name":"sortingComposer","abstract":"<p>Sorting composer</p>","parent_name":"StringMetadata"},"Classes/M4AFile/Metadata/StringMetadata.html":{"name":"StringMetadata","abstract":"<p>Metadata with a data type of string</p>","parent_name":"Metadata"},"Classes/M4AFile/Metadata/IntMetadata.html":{"name":"IntMetadata","abstract":"<p>Metadata with a data type of int</p>","parent_name":"Metadata"},"Classes/M4AFile/Metadata/TwoIntMetadata.html":{"name":"TwoIntMetadata","abstract":"<p>Metadata consisting of two 16-bit integers</p>","parent_name":"Metadata"},"Classes/M4AFile/Metadata/ImageMetadata.html":{"name":"ImageMetadata","abstract":"<p>Metadata with a date type of image</p>","parent_name":"Metadata"},"Classes/M4AFile/M4AFileError.html#/s:8M4ATools0A5AFileC0aC5ErrorO16invalidBlockTypeA2EmF":{"name":"invalidBlockType","abstract":"<p>When a block of an unknown type is loaded</p>","parent_name":"M4AFileError"},"Classes/M4AFile/M4AFileError.html#/s:8M4ATools0A5AFileC0aC5ErrorO11invalidFileA2EmF":{"name":"invalidFile","abstract":"<p>When a file is not valid M4A</p>","parent_name":"M4AFileError"},"Classes/M4AFile/M4AFileError.html":{"name":"M4AFileError","abstract":"<p>M4A file related errors</p>","parent_name":"M4AFile"},"Classes/M4AFile/Metadata.html":{"name":"Metadata","abstract":"<p>Metadata type identifier strings</p>","parent_name":"M4AFile"},"Classes/M4AFile.html#/s:8M4ATools0A5AFileCAC10Foundation4DataV4data_tKcfc":{"name":"init(data:)","abstract":"<p>Creates an instance from data</p>","parent_name":"M4AFile"},"Classes/M4AFile.html#/s:8M4ATools0A5AFileCAC10Foundation3URLV3url_tKcfc":{"name":"init(url:)","abstract":"<p>Initizlizes <code>M4AFile</code> from a <code>URL</code></p>","parent_name":"M4AFile"},"Classes/M4AFile.html#/s:8M4ATools0A5AFileC5writey10Foundation3URLV3url_tKF":{"name":"write(url:)","abstract":"<p>Outputs an M4A file</p>","parent_name":"M4AFile"},"Classes/M4AFile.html#/s:8M4ATools0A5AFileC17getStringMetadataSSSgAC0F0O0eF0OF":{"name":"getStringMetadata(_:)","abstract":"<p>Retrieves metadata of the <code>String</code> type</p>","parent_name":"M4AFile"},"Classes/M4AFile.html#/s:8M4ATools0A5AFileC14getIntMetadatas5UInt8VSgAC0F0O0eF0OF":{"name":"getIntMetadata(_:)","abstract":"<p>Retrieves metadata of the <code>UInt8</code> type</p>","parent_name":"M4AFile"},"Classes/M4AFile.html#/s:8M4ATools0A5AFileC17getTwoIntMetadatas6UInt16V_AFtSgAC0G0O0efG0OF":{"name":"getTwoIntMetadata(_:)","abstract":"<p>Retrieves metadata consisting of two unsigned 16-bit integers</p>","parent_name":"M4AFile"},"Classes/M4AFile.html#/s:8M4ATools0A5AFileC17setStringMetadatayAC0F0O0eF0O_SS5valuetF":{"name":"setStringMetadata(_:value:)","abstract":"<p>Sets a <code>String</code> metadata key</p>","parent_name":"M4AFile"},"Classes/M4AFile.html#/s:8M4ATools0A5AFileC14setIntMetadatayAC0F0O0eF0O_s5UInt8V5valuetF":{"name":"setIntMetadata(_:value:)","abstract":"<p>Sets a <code>UInt8</code> metadata key</p>","parent_name":"M4AFile"},"Classes/M4AFile.html#/s:8M4ATools0A5AFileC17setTwoIntMetadatayAC0G0O0efG0O_s6UInt16V_AJt5valuetF":{"name":"setTwoIntMetadata(_:value:)","abstract":"<p>Sets a two int metadata key</p>","parent_name":"M4AFile"},"Classes/M4AFile.html":{"name":"M4AFile","abstract":"<p>Editable representation of a M4A audio file</p>"},"Classes.html":{"name":"Classes","abstract":"<p>The following classes are available globally.</p>"}}
{}
Binary file modified docs/docsets/.docset/Contents/Resources/docSet.dsidx
Binary file not shown.
Binary file modified docs/docsets/.tgz
Binary file not shown.
18 changes: 2 additions & 16 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<a title=" Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (100% documented)</p>
<p><a href="index.html"> Docs</a> (0% documented)</p>
</div>
</header>
<div class="content-wrapper">
Expand All @@ -26,20 +26,6 @@
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/M4AFile.html">M4AFile</a>
</li>
<li class="nav-group-task">
<a href="Classes/M4AFile/M4AFileError.html">– M4AFileError</a>
</li>
<li class="nav-group-task">
<a href="Classes/M4AFile/Metadata.html">– Metadata</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
Expand All @@ -53,7 +39,7 @@ <h1 id='m4atools' class='heading'>M4ATools</h1>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-14)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-03-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit 3a60da8

Please sign in to comment.