Skip to content

Commit 0f5f6ed

Browse files
HBehrensHBehrens
committed
fixes wrong paths in appledoc target + updated documentation
1 parent 7d0d2f5 commit 0f5f6ed

File tree

6 files changed

+159
-140
lines changed

6 files changed

+159
-140
lines changed

‎BeamMusicPlayerExample.xcodeproj/project.pbxproj

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@
7575
CB0DC57415B69ADE0045921A /* UIImageView+Reflection.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "UIImageView+Reflection.h"; sourceTree = "<group>"; };
7676
CB0DC57515B69ADE0045921A /* UIImageView+Reflection.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "UIImageView+Reflection.m"; sourceTree = "<group>"; };
7777
CB0DC58D15B6AD300045921A /* BeamMusicPlayerViewController.xib */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = file.xib; path = BeamMusicPlayerViewController.xib; sourceTree = "<group>"; };
78-
CB0DC5A615B71BD00045921A /* libPods.a */ = {isa = PBXFileReference; lastKnownFileType = file; name = libPods.a; path = "Pods/build/Release-iphoneos/libPods.a"; sourceTree = "<group>"; };
79-
CB0DC5A915B71C940045921A /* BeamMPMusicPlayerProviderTests.h */ = {isa = PBXFileReference; fileEncoding = 4; path = BeamMPMusicPlayerProviderTests.h; sourceTree = "<group>"; };
78+
CB0DC5A615B71BD00045921A /* libPods.a */ = {isa = PBXFileReference; lastKnownFileType = archive.ar; name = libPods.a; path = "Pods/build/Release-iphoneos/libPods.a"; sourceTree = "<group>"; };
79+
CB0DC5A915B71C940045921A /* BeamMPMusicPlayerProviderTests.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = BeamMPMusicPlayerProviderTests.h; sourceTree = "<group>"; };
8080
CB0DC5AA15B71C940045921A /* BeamMPMusicPlayerProviderTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = BeamMPMusicPlayerProviderTests.m; sourceTree = "<group>"; };
8181
CB35A6F81576916C008318EE /* BeamMusicPlayerDataSource.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = BeamMusicPlayerDataSource.h; sourceTree = "<group>"; };
8282
CB35A6F91576916C008318EE /* BeamMusicPlayerDelegate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = BeamMusicPlayerDelegate.h; sourceTree = "<group>"; };
@@ -289,7 +289,7 @@
289289
/* Begin PBXLegacyTarget section */
290290
CB35A70015769221008318EE /* appledoc */ = {
291291
isa = PBXLegacyTarget;
292-
buildArgumentsString = "--project-name BeamMusicPlayerViewController --project-company \"BeamApp UG\" --company-id com.beamapp --output ${PROJECT_DIR}/Documentation --no-create-docset --no-repeat-first-par --logformat xcode ${PROJECT_DIR}/BeamMusicPlayerExample/Source/BeamMusicPlayerViewController.h ${PROJECT_DIR}/BeamMusicPlayerExample/Source/BeamMusicPlayerDataSource.h ${PROJECT_DIR}/BeamMusicPlayerExample/Source/BeamMusicPlayerDelegate.h";
292+
buildArgumentsString = "--project-name BeamMusicPlayerViewController --project-company \"BeamApp UG\" --company-id com.beamapp --output ${PROJECT_DIR}/Documentation --no-create-docset --no-repeat-first-par --logformat xcode ${PROJECT_DIR}/Source/BeamMusicPlayerViewController.h ${PROJECT_DIR}/Source/BeamMusicPlayerDataSource.h ${PROJECT_DIR}/Source/BeamMusicPlayerDelegate.h";
293293
buildConfigurationList = CB35A70115769221008318EE /* Build configuration list for PBXLegacyTarget "appledoc" */;
294294
buildPhases = (
295295
);

‎Documentation/html/Classes/BeamMusicPlayerViewController.html

Lines changed: 144 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ <h1 class="hideInXcode">BeamMusicPlayerViewController Class Reference</h1>
4040

4141
<option value="properties">Properties</option>
4242

43+
<option value="//api/name/actionBlock">&nbsp;&nbsp;&nbsp;&nbsp;actionBlock</option>
44+
45+
<option value="//api/name/backBlock">&nbsp;&nbsp;&nbsp;&nbsp;backBlock</option>
46+
4347
<option value="//api/name/currentPlaybackPosition">&nbsp;&nbsp;&nbsp;&nbsp;currentPlaybackPosition</option>
4448

4549
<option value="//api/name/currentTrack">&nbsp;&nbsp;&nbsp;&nbsp;currentTrack</option>
@@ -48,6 +52,8 @@ <h1 class="hideInXcode">BeamMusicPlayerViewController Class Reference</h1>
4852

4953
<option value="//api/name/delegate">&nbsp;&nbsp;&nbsp;&nbsp;delegate</option>
5054

55+
<option value="//api/name/placeholderImageDelay">&nbsp;&nbsp;&nbsp;&nbsp;placeholderImageDelay</option>
56+
5157
<option value="//api/name/playing">&nbsp;&nbsp;&nbsp;&nbsp;playing</option>
5258

5359
<option value="//api/name/preferredSizeForCoverArt">&nbsp;&nbsp;&nbsp;&nbsp;preferredSizeForCoverArt</option>
@@ -113,6 +119,10 @@ <h1 class="hideInXcode">BeamMusicPlayerViewController Class Reference</h1>
113119

114120
<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul>
115121

122+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/actionBlock">actionBlock</a></span></li>
123+
124+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/backBlock">backBlock</a></span></li>
125+
116126
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/currentPlaybackPosition">currentPlaybackPosition</a></span></li>
117127

118128
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/currentTrack">currentTrack</a></span></li>
@@ -121,6 +131,8 @@ <h1 class="hideInXcode">BeamMusicPlayerViewController Class Reference</h1>
121131

122132
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/delegate">delegate</a></span></li>
123133

134+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/placeholderImageDelay">placeholderImageDelay</a></span></li>
135+
124136
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/playing">playing</a></span></li>
125137

126138
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/preferredSizeForCoverArt">preferredSizeForCoverArt</a></span></li>
@@ -180,9 +192,6 @@ <h1 class="title title-header">BeamMusicPlayerViewController Class Reference</h1
180192
<tr>
181193
<td class="specification-title">Inherits from</td>
182194
<td class="specification-value">UIViewController</td>
183-
</tr><tr>
184-
<td class="specification-title">Conforms to</td>
185-
<td class="specification-value">OBSliderDelegate</td>
186195
</tr><tr>
187196
<td class="specification-title">Declared in</td>
188197
<td class="specification-value">BeamMusicPlayerViewController.h</td>
@@ -341,6 +350,20 @@ <h3 class="subsubtitle task-title">Controlling User Interaction</h3>
341350
</span>
342351
<span class="task-item-suffix">property</span>
343352

353+
</li><li>
354+
<span class="tooltip">
355+
<code><a href="#//api/name/backBlock">&nbsp;&nbsp;backBlock</a></code>
356+
<span class="tooltip"><p>Block to be executed if the user presses the back button at the top. Button is hidden, if nil.</p></span>
357+
</span>
358+
<span class="task-item-suffix">property</span>
359+
360+
</li><li>
361+
<span class="tooltip">
362+
<code><a href="#//api/name/actionBlock">&nbsp;&nbsp;actionBlock</a></code>
363+
<span class="tooltip"><p>Block to be executed if the user presses the action button at the top right. Button is hidden, if nil.</p></span>
364+
</span>
365+
<span class="task-item-suffix">property</span>
366+
344367
</li>
345368
</ul>
346369

@@ -356,6 +379,13 @@ <h3 class="subsubtitle task-title">Misc</h3>
356379
</span>
357380
<span class="task-item-suffix">property</span>
358381

382+
</li><li>
383+
<span class="tooltip">
384+
<code><a href="#//api/name/placeholderImageDelay">&nbsp;&nbsp;placeholderImageDelay</a></code>
385+
<span class="tooltip"><p>Timespan before placeholder for albumart will be set (default is 0.5). Supports long loading times.</p></span>
386+
</span>
387+
<span class="task-item-suffix">property</span>
388+
359389
</li>
360390
</ul>
361391

@@ -369,6 +399,78 @@ <h3 class="subsubtitle task-title">Misc</h3>
369399
<a title="Properties" name="properties"></a>
370400
<h2 class="subtitle subtitle-methods">Properties</h2>
371401

402+
<div class="section-method">
403+
<a name="//api/name/actionBlock" title="actionBlock"></a>
404+
<h3 class="subsubtitle method-title">actionBlock</h3>
405+
406+
407+
408+
<div class="method-subsection brief-description">
409+
<p>Block to be executed if the user presses the action button at the top right. Button is hidden, if nil.</p>
410+
</div>
411+
412+
413+
414+
<div class="method-subsection method-declaration"><code>@property (nonatomic, copy) void ( ^ ) ( ) actionBlock</code></div>
415+
416+
417+
418+
419+
420+
421+
422+
423+
424+
425+
426+
427+
428+
429+
430+
<div class="method-subsection declared-in-section">
431+
<h4 class="method-subtitle">Declared In</h4>
432+
<code class="declared-in-ref">BeamMusicPlayerViewController.h</code><br />
433+
</div>
434+
435+
436+
</div>
437+
438+
<div class="section-method">
439+
<a name="//api/name/backBlock" title="backBlock"></a>
440+
<h3 class="subsubtitle method-title">backBlock</h3>
441+
442+
443+
444+
<div class="method-subsection brief-description">
445+
<p>Block to be executed if the user presses the back button at the top. Button is hidden, if nil.</p>
446+
</div>
447+
448+
449+
450+
<div class="method-subsection method-declaration"><code>@property (nonatomic, copy) void ( ^ ) ( ) backBlock</code></div>
451+
452+
453+
454+
455+
456+
457+
458+
459+
460+
461+
462+
463+
464+
465+
466+
<div class="method-subsection declared-in-section">
467+
<h4 class="method-subtitle">Declared In</h4>
468+
<code class="declared-in-ref">BeamMusicPlayerViewController.h</code><br />
469+
</div>
470+
471+
472+
</div>
473+
372474
<div class="section-method">
373475
<a name="//api/name/currentPlaybackPosition" title="currentPlaybackPosition"></a>
374476
<h3 class="subsubtitle method-title">currentPlaybackPosition</h3>
@@ -381,7 +483,7 @@ <h3 class="subsubtitle method-title">currentPlaybackPosition</h3>
381483

382484

383485

384-
<div class="method-subsection method-declaration"><code>@property (nonatomic, readonly) CGFloat currentPlaybackPosition</code></div>
486+
<div class="method-subsection method-declaration"><code>@property (nonatomic) CGFloat currentPlaybackPosition</code></div>
385487

386488

387489

@@ -417,7 +519,7 @@ <h3 class="subsubtitle method-title">currentTrack</h3>
417519

418520

419521

420-
<div class="method-subsection method-declaration"><code>@property (nonatomic) NSUInteger currentTrack</code></div>
522+
<div class="method-subsection method-declaration"><code>@property (nonatomic) NSInteger currentTrack</code></div>
421523

422524

423525

@@ -505,6 +607,42 @@ <h3 class="subsubtitle method-title">delegate</h3>
505607

506608

507609

610+
<div class="method-subsection declared-in-section">
611+
<h4 class="method-subtitle">Declared In</h4>
612+
<code class="declared-in-ref">BeamMusicPlayerViewController.h</code><br />
613+
</div>
614+
615+
616+
</div>
617+
618+
<div class="section-method">
619+
<a name="//api/name/placeholderImageDelay" title="placeholderImageDelay"></a>
620+
<h3 class="subsubtitle method-title">placeholderImageDelay</h3>
621+
622+
623+
624+
<div class="method-subsection brief-description">
625+
<p>Timespan before placeholder for albumart will be set (default is 0.5). Supports long loading times.</p>
626+
</div>
627+
628+
629+
630+
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) float placeholderImageDelay</code></div>
631+
632+
633+
634+
635+
636+
637+
638+
639+
640+
641+
642+
643+
644+
645+
508646
<div class="method-subsection declared-in-section">
509647
<h4 class="method-subtitle">Declared In</h4>
510648
<code class="declared-in-ref">BeamMusicPlayerViewController.h</code><br />
@@ -1036,7 +1174,7 @@ <h4 class="method-subtitle">Declared In</h4>
10361174
<div id="footer">
10371175
<hr />
10381176
<div class="footer-copyright">
1039-
<p><span class="copyright">&copy; 2012 BeamApp UG. All rights reserved. (Last updated: 2012-06-01)</span><br />
1177+
<p><span class="copyright">&copy; 2012 BeamApp UG. All rights reserved. (Last updated: 2012-07-22)</span><br />
10401178

10411179
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 789)</a>.</span></p>
10421180

‎Documentation/html/Protocols/BeamMusicPlayerDataSource.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -519,7 +519,7 @@ <h3 class="subsubtitle method-title">numberOfTracksInPlayer:</h3>
519519

520520

521521

522-
<div class="method-subsection method-declaration"><code>- (NSUInteger)numberOfTracksInPlayer:(BeamMusicPlayerViewController *)<em>player</em></code></div>
522+
<div class="method-subsection method-declaration"><code>- (NSInteger)numberOfTracksInPlayer:(BeamMusicPlayerViewController *)<em>player</em></code></div>
523523

524524

525525

@@ -537,7 +537,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
537537

538538
<div class="method-subsection return">
539539
<h4 class="method-subtitle parameter-title">Return Value</h4>
540-
<p>number of available tracks</p>
540+
<p>number of available tracks, -1 if unknown</p>
541541
</div>
542542

543543

@@ -571,7 +571,7 @@ <h4 class="method-subtitle">Declared In</h4>
571571
<div id="footer">
572572
<hr />
573573
<div class="footer-copyright">
574-
<p><span class="copyright">&copy; 2012 BeamApp UG. All rights reserved. (Last updated: 2012-06-01)</span><br />
574+
<p><span class="copyright">&copy; 2012 BeamApp UG. All rights reserved. (Last updated: 2012-07-22)</span><br />
575575

576576
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 789)</a>.</span></p>
577577

0 commit comments

Comments
 (0)