Docs for 0.5.0

jwang · Jul 29, 2011 · c08fe94 · c08fe94
1 parent 88fcb0b
commit c08fe94
Show file tree

Hide file tree

Showing 3 changed files with 104 additions and 20 deletions.
diff --git 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.4.1.0
+PROJECT_NUMBER         = 0.5.0
 
 # 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/src/Doxygen.h b/src/Doxygen.h
@@ -112,6 +112,90 @@
  * Presented here are the API diffs for each major release of Nimbus.
  */
 
+/**
+ * @defgroup Version-5-0 Version 0.5 API Changes
+ * @ingroup Version-History
+ *
+ * Version 0.5.0 of Nimbus was released on July 29, 2011. This major version introduced the new
+ * Nimbus @link NimbusOverview Overview@endlink, a debugging tool that shows detailed information
+ * about the state of your device and application in the device's status bar area.
+ *
+ * @image html overview1.png "The Overview added to the network photo album app."
+ *
+ *
+ * <h2>Added Frameworks</h2>
+ *
+ * - @link NimbusOverview Nimbus Overview@endlink
+ *
+ *
+ * <h2>Core</h2>
+ *
+ * <h3>NICommonMetrics[.h]</h3>
+ *
+ * - <span class="apiDiffAdded">Added</span> <code>NIStatusBarFrameAnimationCurve()</code>
+ * - <span class="apiDiffAdded">Added</span> <code>NIStatusBarFrameAnimationDuration()</code>
+ * - <span class="apiDiffAdded">Added</span> <code>NIStatusBarHeight()</code>
+ * - <span class="apiDiffAdded">Added</span> <code>NIDeviceRotationDuration()</code>
+ *
+ * <h3>NIDataStructures[.h]</h3>
+ *
+ * - <span class="apiDiffAdded">Added</span> <code>[NILinkedList @link NILinkedList::objectEnumerator objectEnumerator@endlink]</code>
+ *
+ * <h3>NIDeviceOrientation[.h]</h3>
+ *
+ * - <span class="apiDiffAdded">Added</span> <code>NIRotateTransformForOrientation()</code>
+ *
+ *
+ * <h2>Network Image</h2>
+ *
+ * <h3>NINetworkImageView[.m]</h3>
+ *
+ * - <span class="apiDiffBugfix">Bugfix</span> Cancel network requests without blocking on the main thread.
+ *
+ *
+ * <h2>Photos</h2>
+ *
+ * <h3>NIToolbarPhotoViewController[.m]</h3>
+ *
+ * - <span class="apiDiffBugfix">Bugfix</span> Fix various memory leaks related to not releasing views on dealloc.
+ * - <span class="apiDiffBugfix">Bugfix</span> Fix memory leak when toggling the toolbar mode between a scrubber and buttons.
+ *
+ *
+ * <h2>Examples</h2>
+ *
+ * <h3>NetworkPhotoAlbums</h3>
+ *
+ * - <span class="apiDiffBugfix">Bugfix</span> Fix various memory leaks related to not releasing views on dealloc.
+ *
+ *
+ * <h2>Real Live People Involved in this Release</h2>
+ *
+ * <div class="contributor_profile"> 
+ *  <img width="135px" height="135px" src="http://www.gravatar.com/avatar/f3c8603c353afa79b9f1c77f35efd566?s=135&amp;d=http://three20.info/gfx/team/silhouette.gif" /> 
+ *  <div class="name">Jeff Verkoeyen</div> 
+ *  <div class="github"><a href="http://github.com/jverkoey">jverkoey</a></div> 
+ * </div>
+ *
+ * <div class="clearfix"></div>
+ *
+ * <h3>Add Your Name to This List</h3>
+ *
+ * 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 <a href="https://github.com/jverkoey/nimbus/issues?sort=created&direction=desc&state=open&page=1&milestone=5">tasks grab bag</a>
+ * for opportunities to help out.
+ *
+ * <h2>Robots Involved in this Release</h2>
+ *
+ * <div class="contributor_profile"> 
+ *  <div class="name"><a href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</a></div> 
+ * </div>
+ *
+ * <div class="clearfix"></div>
+ */
+
 /**
  * @defgroup Version-4 Version 0.4 API Changes
  * @ingroup Version-History

diff --git a/src/overview/src/NimbusOverview.h b/src/overview/src/NimbusOverview.h
@@ -25,25 +25,6 @@
  * scroll view beneath the status bar that contains any number of pages of information.
  * These pages can show anything from graphs of current memory usage to console logs to
  * configuration settings.
- 
- *
- * <h2>How to Use the Overview</h2>
- *
- * To begin using the Overview you need to add two lines of code to your app and define
- * DEBUG in your applicaton's preprocessor macros Debug target settings.
- *
- * @code
- - (BOOL)              application:(UIApplication *)application
- *    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
- *  // Line #1 - Swizzles the necessary methods for making the Overview appear as part of the
- *  // the status bar.
- *  [NIOverview applicationDidFinishLaunching];
- *
- *  // Create the UIWindow for your application.
- *
- *  // Line #2 - Adds the Overview view to the window.
- *  [NIOverview addOverviewToWindow:self.window];
- * @endcode
  *
  * @image html overview1.png "The Overview added to the network photo album app."
  *
@@ -81,6 +62,25 @@
  * This page allows you to modify NIMaxLogLevel while the app is running.
  *
  *
+ * <h2>How to Use the Overview</h2>
+ *
+ * To begin using the Overview you need to add two lines of code to your app and define
+ * DEBUG in your applicaton's preprocessor macros Debug target settings.
+ *
+ * @code
+ - (BOOL)              application:(UIApplication *)application
+ *    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
+ *  // Line #1 - Swizzles the necessary methods for making the Overview appear as part of the
+ *  // the status bar.
+ *  [NIOverview applicationDidFinishLaunching];
+ *
+ *  // Create the UIWindow for your application.
+ *
+ *  // Line #2 - Adds the Overview view to the window.
+ *  [NIOverview addOverviewToWindow:self.window];
+ * @endcode
+ *
+ *
  * <h2>Events</h2>
  *
  * Certain events are useful in providing context while debugging an application. When a