Browse files

Update documentation and fight with appledoc

  • Loading branch information...
1 parent 943321f commit c05bfa5db309c6587dfa11d4c538d30e17eef758 @soffes soffes committed May 21, 2012
Showing with 21 additions and 20 deletions.
  1. +17 −14 Rakefile
  2. +1 −6 SSToolkit/SSCollectionView.h
  3. +3 −0 SSToolkit/SSRateLimit.h
View
31 Rakefile
@@ -1,36 +1,39 @@
+version = `cat VERSION`.strip
+output = Dir.pwd + '/Documentation'
appledoc_options = [
- '--output Documentation',
+ "--output \"#{output}\"",
'--project-name SSToolkit',
- '--project-company \'Sam Soffes\'',
+ '--project-company "Sam Soffes"',
'--company-id com.samsoffes',
- "--project-version #{`cat VERSION`.strip}",
+ "--project-version #{version}",
'--keep-intermediate-files',
'--create-html',
- '--templates ~/Library/Application\ Support/appledoc/Templates/',
'--no-repeat-first-par',
- '--verbose']
+ '--verbose',
+ '--create-docset',
+ # '--docset-platform-family appledoc'
+]
namespace :docs do
- desc 'Clean docs'
+ desc 'Clean docs output'
task :clean do
`rm -rf Documentation`
end
desc 'Install docs'
task :install => [:'docs:clean'] do
- `appledoc #{appledoc_options.join(' ')} --create-docset --install-docset SSToolkit/*.h`
+ `appledoc #{appledoc_options.join(' ')} --install-docset SSToolkit/*.h`
end
- desc 'Publish docs'
+ desc 'Create publishable docs'
task :publish => [:'docs:clean'] do
extra_options = [
- '--create-docset',
- '--publish-docset',
- '--install-docset',
+ # '--publish-docset',
+ '--docset-copyright "2012 Sam Soffes"',
'--docset-atom-filename com.samsoffes.sstoolkit.atom',
- '--docset-feed-url http://docs.sstoolk.it/%DOCSETATOMFILENAME',
- '--docset-package-url http://docs.sstoolk.it/%DOCSETPACKAGEFILENAME'
- ]
+ '--docset-feed-url "http://docs.sstoolk.it/%DOCSETATOMFILENAME"',
+ '--docset-package-url "http://docs.sstoolk.it/%DOCSETPACKAGEFILENAME"'
+ ]
`appledoc #{appledoc_options.join(' ')} #{extra_options.join(' ')} SSToolkit/*.h`
end
end
View
7 SSToolkit/SSCollectionView.h
@@ -188,8 +188,6 @@ typedef enum {
@param item An item object of the collection view.
@return An index path representing the row and section of the item or `nil` if the index path is invalid.
-
- @see itemPathForIndex:
*/
- (NSIndexPath *)indexPathForItem:(SSCollectionViewItem *)item;
@@ -537,7 +535,7 @@ typedef enum {
@param aCollectionView The collection view object requesting this information.
- @param An index path that locates a item in `aCollectionView`.
+ @param section The section to size items.
@return A value that specifies the size (in points) that item should be.
@@ -561,9 +559,6 @@ typedef enum {
@param item A collection view item object that `aCollectionView` is going to use when drawing the item.
@param indexPath An index path locating the item in `aCollectionView`.
-
- @see collectionView:itemForIndexPath:
- @see prepareForReuse
*/
- (void)collectionView:(SSCollectionView *)aCollectionView willDisplayItem:(SSCollectionViewItem *)item atIndexPath:(NSIndexPath *)indexPath;
View
3 SSToolkit/SSRateLimit.h
@@ -6,6 +6,9 @@
// Copyright (c) 2012 Sam Soffes. All rights reserved.
//
+/**
+ Simple utility for only executing code every so often.
+ */
@interface SSRateLimit : NSObject
/**

0 comments on commit c05bfa5

Please sign in to comment.