diff --git a/README.mdown b/README.mdown index cdab7bbbf..108fdbf05 100644 --- a/README.mdown +++ b/README.mdown @@ -1,41 +1,11 @@ Nimbus is an iOS framework whose feature set grows only as fast as its documentation. -By focusing on documentation first and features second, Nimbus hopes to be a framework -that accelerates the development process of any application by being easy to use and simple -to understand. -

Getting Started

- Visit the Nimbus website at nimbuskit.info. +- Learn when and why you should use Nimbus. - Add Nimbus to your project. -- Follow Nimbus' development through its version history. -- See the latest API diffs. -- Read the Three20 Migration Guide. +- Follow Nimbus' development through its version history. +- See the latest API diffs. +- Read the Three20 Migration Guide. - Ask questions and get updates via the Nimbus mailing list. - -

Nimbus' Background

- -Nimbus has been built with much inspiration from the Three20 framework. That being said, there -are a number of fundamental problems with Three20 that Nimbus works very hard to avoid. -Among them: - -- Poor documentation. -- Spaghetti dependencies. -- Suffering from a "kitchen sink" complex. -- A complex build structure. -- An enormous number of difficult-to-solve bugs. -- Next-to-zero test coverage. - -For its weaknesses, Three20 does provide a good deal of value through its feature set. It is -used in over 100 apps in the app store by companies such as Facebook, LinkedIn, Posterous, -Meetup, and SCVNGR. - -Nimbus hopes to one day provide as much value as Three20 does on a feature-by-feature -comparison, but with the invaluable benefit of sublime documentation and test coverage. - -

Nimbus' Development Roadmap

- -Most of the discussion revolving around Nimbus' roadmap is in the Github issue tracker. In -particular, check out the grab bag of tasks that are actively being worked on here: - -https://github.com/jverkoey/nimbus/issues?milestone=5&sort=created&direction=desc&state=open diff --git a/docs/Doxyfile b/docs/Doxyfile index 0759cd0f0..1986a406d 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -31,7 +31,7 @@ PROJECT_NAME = Nimbus # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 0.9.2 +PROJECT_NUMBER = 0.9.3 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer diff --git a/docs/Doxyfile-docset b/docs/Doxyfile-docset index 3a6020a2e..14e9d9d0d 100644 --- a/docs/Doxyfile-docset +++ b/docs/Doxyfile-docset @@ -25,13 +25,13 @@ DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. -PROJECT_NAME = "Nimbus 0.9.2 Library" +PROJECT_NAME = "Nimbus 0.9.3 Library" # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 0.9.2 +PROJECT_NUMBER = 0.9.3 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer diff --git a/docs/nimbusdocset.atom b/docs/nimbusdocset.atom index 9b60da842..149ae7c33 100644 --- a/docs/nimbusdocset.atom +++ b/docs/nimbusdocset.atom @@ -3,13 +3,23 @@ xml:lang="en"> http://jverkoey.github.com/nimbus Nimbus Documentation - 2012-02-19T12:00:01Z + 2012-06-10T12:00:01Z Jeff Verkoeyen - http://jverkoey.github.com/nimbus + http://nimbuskit.info/ Copyright (c) 2012, Jeff Verkoeyen + + http://jverkoey.github.com/nimbus/docsets/org.jeffverkoeyen.nimbus.0.9.3 + Nimbus Documentation + Includes reference for Nimbus + 2012-06-10T12:00:00Z + + org.jeffverkoeyen.nimbus + 0.9.3 + 4.0 + http://jverkoey.github.com/nimbus/docsets/org.jeffverkoeyen.nimbus.0.9.2 Nimbus Documentation diff --git a/src/Doxygen.h b/src/Doxygen.h index 2565789a9..4a423fcf0 100644 --- a/src/Doxygen.h +++ b/src/Doxygen.h @@ -1,5 +1,5 @@ // -// Copyright 2011 Jeff Verkoeyen +// Copyright 2011-2012 Jeff Verkoeyen // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -26,9 +26,10 @@ *

Getting Started

* * - Add Nimbus to your project. - * - Follow Nimbus' development through its version history. - * - See the latest API diffs. - * - Read the Three20 Migration Guide. + * - Learn when and why you should use Nimbus. + * - Follow Nimbus' development through its version history. + * - See the latest API diffs. + * - Read the Three20 Migration Guide. * - Ask questions and get updates via the Nimbus mailing list. * *

Nimbus' Background

@@ -67,35 +68,186 @@ * * http://pledgie.com/campaigns/15519 * - *

Source Code Contributors (alphabetical by last name)

+ *
* - *
- *
bubnov
- *
bubnov
- *
- * - *
- * - *
Roger Chapman
- *
rogchap
- *
+ *

Generous Donations Have Been Made By the Following People

* - *
- * - *
Manu Cornet
- *
lmanul
- *
+ * - Peter Nelson + * - Craig Gilchrist + * - Atsushi Nagase * - *
- * - *
Adam Doppelt
- *
gurgeous
- *
+ *

Nimbus' Background

+ * + * Nimbus has been built with much inspiration from the Three20 framework. That being said, there + * are a number of fundamental problems with Three20 that Nimbus works very hard to avoid. + * Among them: + * + * - Poor documentation. + * - Spaghetti dependencies. + * - Suffering from a "kitchen sink" complex. + * - A complex build structure. + * - An enormous number of difficult-to-solve bugs. + * - Next-to-zero test coverage. + * + * For its weaknesses, Three20 does provide a good deal of value through its feature set. It is + * used in over 100 apps in the app store by companies such as Facebook, LinkedIn, Posterous, + * Meetup, and SCVNGR. + * + * Nimbus hopes to one day provide as much value as Three20 does on a feature-by-feature + * comparison, but with the invaluable benefit of sublime documentation and test coverage. + * + *

Nimbus' Development Roadmap

+ * + * Most of the discussion revolving around Nimbus' roadmap is in the Github issue tracker. In + * particular, check out the grab bag of tasks that are actively being worked on here: + * + * https://github.com/jverkoey/nimbus/issues?milestone=5&sort=created&direction=desc&state=open + */ + +/** + * @defgroup Version-History Version History + * + * Presented here are the API diffs for each major release of Nimbus. + */ + +/** + * @defgroup Version-9-3 Version 0.9.3 API Changes + * @ingroup Version-9-0 + * + * Version 0.9.3 of Nimbus was released on June 10, 2012. This minor version introduces + * table view actions and radio groups. + * + *

Misc Changes

+ * + * - Code coverage is no longer automatically generated when the Nimbus targets are built. + * - Removed the unmaintained "Getting Started" example project. + * + * + *

Attributed Label

+ * + *

NIAttributedLabel

+ * + * - Bugfix 183 Don't incorrectly disable user interaction (thanks to SevInf). + * - Added [NIAttributedLabel @link NIAttributedLabel::linksHaveUnderlines linksHaveUnderlines@endlink]. + * - Bugfix 194 Don't allow attributed labels with multiple lines to have line break modes other than word wrap. + * + * + *

Core

+ * + *

NIOperations

+ * + * - Bugfix 172 Correctly handle error codes in NINetworkRequestOperation (thanks to Vaseltior). + * - Modified NIOperation.@link NIOperation::didStart didStart@endlink + * @htmlonly + * + *
Method Name
From- (void)operationDidStart
To- (void)didStart
@endhtmlonly + * - Modified NIOperation.@link NIOperation::operationDidFinish operationDidFinish@endlink + * @htmlonly + * + *
Method Name
From- (void)operationDidFinish
To- (void)didFinish
@endhtmlonly + * - Modified NIOperation.@link NIOperation::operationDidFailWithError: operationDidFailWithError:@endlink + * @htmlonly + * + *
Method Name
From- (void)operationDidFailWithError:(NSError *)error
To- (void)didFailWithError:(NSError *)error
@endhtmlonly + * - Modified NIOperation.@link NIOperation::operationWillFinish operationWillFinish@endlink + * @htmlonly + * + *
Method Name
From- (void)operationWillFinish
To- (void)willFinish
@endhtmlonly + * - Modified NIOperationDelegate.@link NIOperationDelegate::nimbusOperationDidStart: nimbusOperationDidStart:@endlink + * @htmlonly + * + *
Method Name
From- (void)operationDidStart:(NSOperation *)operation
To- (void)nimbusOperationDidStart:(NIOperation *)operation
@endhtmlonly + * - Modified NIOperationDelegate.@link NIOperationDelegate::nimbusOperationWillFinish: nimbusOperationWillFinish:@endlink + * @htmlonly + * + *
Method Name
From- (void)operationWillFinish:(NSOperation *)operation
To- (void)nimbusOperationWillFinish:(NIOperation *)operation
@endhtmlonly + * - Modified NIOperationDelegate.@link NIOperationDelegate::nimbusOperationDidFinish: nimbusOperationDidFinish:@endlink + * @htmlonly + * + *
Method Name
From- (void)operationDidFinish:(NSOperation *)operation
To- (void)nimbusOperationDidFinish:(NIOperation *)operation
@endhtmlonly + * - Modified NIOperationDelegate.@link NIOperationDelegate::nimbusOperationDidFail:withError: nimbusOperationDidStart:@endlink + * @htmlonly + * + *
Method Name
From- (void)operationDidFail:(NSOperation *)operation withError:(NSError *)error
To- (void)nimbusOperationDidFail:(NIOperation *)operation withError:(NSError *)error
@endhtmlonly + * + *

Css

+ * + *

README

+ * + * - Fixed the command line statements in the README for setting up Chameleon. + * - Fixed analyzer warnings in CSSTokenizer.m. + * - Added 192 Add UIToolbar and UISearchBar CSS theming (thanks to subsymbolic). + * - Added Add UIActivityIndicatorView CSS theming. + * - Added Add UIScrollView and UITableView CSS theming. + * - Added Add support for autoresizing masks via the new -ios-autoresizing css property. + * - Bugfix 185 Maintain the casing of css property values so that fonts can be loaded correctly. + * + * + *

Launcher

+ * + *

NILauncherView

+ * + * - Bugfix 156 NILauncherView can now be used in interface builder (thanks to onomated). + * + * + *

Models

+ * + *

NIFormCellCatalog

+ * + * - Bugfix 162 NILauncherView can now be used in interface builder (thanks to kermitology). + * - Added 155 Documentation written for heightForObject:atIndexPath:tableView: (thanks to alist). + * - Removed NIButtonFormElement. Use NITableViewActions instead. + * - Bugfix Switch table cells now take into account the image when laying out their labels. + * + *

Added NICellCatalog

+ * + * - Added Add @link NITitleCellObject NITitleCellObject@endlink, @link NISubtitleCellObject NISubtitleCellObject@endlink. + * - Added Add @link NITextCell NITextCell@endlink, @link NISubtitleCellObject NISubtitleCellObject@endlink. + * + *

Added NIRadioGroup

+ * + * - Added Add @link NIRadioGroup NIRadioGroup@endlink. + * + *

Added NITableViewActions

+ * + * - Added Add @link NITableViewActions NITableViewActions@endlink. + * + * + *

Network Image

+ * + *

NINetworkImageView

+ * + * - Modified NINetworkImageView.@link NINetworkImageView::networkImageViewDidFailWithError: networkImageViewDidFailWithError:@endlink + * @htmlonly + * + *
Method Name
From- (void)networkImageViewDidFailToLoad:(NSError *)error
To- (void)networkImageViewDidFailWithError:(NSError *)error
@endhtmlonly + * - Modified NINetworkImageViewDelegate.@link NINetworkImageViewDelegate::networkImageView:didFailWithError: networkImageView:didFailWithError:@endlink + * @htmlonly + * + *
Method Name
From- (void)networkImageViewDidFailLoad:(NINetworkImageView *)imageView
To- (void)networkImageView:(NINetworkImageView *)imageView didFailWithError:(NSError *)error
@endhtmlonly + * + * + *

Overview

+ * + *

NIOverviewMemoryCacheController

+ * + * - Added Add @link NIOverviewMemoryCacheController NIOverviewMemoryCacheController@endlink. + * - Added Added an overview page for displaying image cache memory usage. + * + * + *

WebController

+ * + *

NIWebController

+ * + * - Bugfix NIWebController properly stores display information in the event of a memory warning now. + * + * + *

Real Live People Involved in this Release

* *
- * - *
Glenn Grant
- *
alias1
+ * + *
Mia Alexiou
+ *
subsymbolic
*
* *
@@ -104,57 +256,34 @@ *
Vaseltior
*
* - *
- * - *
Aviel Lazar
- *
aviell
- *
- * *
- *
lipeiqiang
- *
lipeiqiang
+ * + *
Pierre de La Morinerie
+ *
kemenaran
*
* *
- * - *
Anthony Lobay
- *
TheMadGamer
+ * + *
Daniel Lemmon
+ *
kermitology
*
* *
- * - *
Benedikt Meurer
- *
bmeurer
+ * + *
Alexander List
+ *
alist
*
* *
- * - *
Mike
- *
prime31
+ * + *
Onome
+ *
onomated
*
* *
- * - *
Anderson Miller
- *
candersonmiller
- *
- * - *
- * - *
Basil Shkara
- *
baz
- *
- * - *
- * - *
Peter Steinberger
- *
steipete
- *
- * - *
- * - *
superquadratic
- *
superquadratic
+ * + *
Sergej Tatarincev
+ *
SevInf
*
* *
@@ -162,59 +291,32 @@ *
Jeff Verkoeyen
*
jverkoey
*
- * - *
- * - *
Hwee-Boon Yar
- *
hboon
- *
* - *
- * - *

Generous Donations Have Been Made By the Following People

- * - * - Peter Nelson - * - Craig Gilchrist - * - Atsushi Nagase - * - * - *

The Nimbus Backstory

- * - * Nimbus was started by me (Jeff Verkoeyen) in June of 2011. My background includes over 10 years - * of software development and experience at Google and Facebook designing software and - * building user interfaces. I took over the Three20 project in 2009 after its original creator, - * Joe Hewitt, moved on to other projects. Over the proceeding 6 months much time was invested in - * splitting the framework apart and attempting to clobber its spaghetti dependencies while - * improving the project's documentation. - * - * In early May of 2010, my life was completely shaken up: my mother suddenly passed - * away at age 42 due to a pulmonary embolism. This is relevant because for the following year - * I checked out of life and, as a direct result, little progress was made with Three20. Over the - * last year I've found that shedding baggage is not only an emotionally satisfying process, but - * also a necessary one. So I am shedding Three20's baggage and out of the remaining bits building - * Nimbus. I learned a great deal from working with an open source project and community and - * sincerely hope to carry much of this knowledge over to Nimbus. - * - * - *

What's happening to Three20?

- * - * My goal with Nimbus is to eventually provide a feature set that overlaps Three20's. I - * sincerely hope to make it easy for anyone using Three20 to transition to Nimbus. In the - * meantime, Three20 will likely stay in a bug-fixing state. The library is stable as it stands - * so I have every bit of confidence in the community to tackle any bugs as necessary. - */ - -/** - * @defgroup Version-History Version History + *
* - * Presented here are the API diffs for each major release of Nimbus. + *

Add Your Name to This List

+ * + * Contributions are highly encouraged! If you have a feature that you feel would fit within the + * Nimbus framework, feel free to fire off a pull request on GitHub. Bugs may be reported + * using the issue tracker on GitHub as well. + * + * Check out the tasks grab bag + * for opportunities to help out. + * + *

Robots Involved in this Release

+ * + *
+ *
Nimbus Doxygen
+ *
+ * + *
*/ /** * @defgroup Version-9-2 Version 0.9.2 API Changes * @ingroup Version-9-0 * - * Version 0.9.2 of Nimbus was released on February 19, 2011. This minor version fixes various bugs. + * Version 0.9.2 of Nimbus was released on February 19, 2012. This minor version fixes various bugs. * * *

Misc Changes