Permalink
Browse files

Documentation updates

  • Loading branch information...
1 parent 9bb2466 commit b8b9692432570faca6a4cb34ca91c0e71c7a97ae @corerd corerd committed Feb 19, 2013
View
4 ADVProgressBar.xcodeproj/project.pbxproj
@@ -14,6 +14,7 @@
92EC8ECD16C0BBC20087B43B /* mainpage.dox in Resources */ = {isa = PBXBuildFile; fileRef = 92EC8ECC16C0BBC20087B43B /* mainpage.dox */; };
92ED54B116AC27F0006A1C73 /* LICENSE.txt in Resources */ = {isa = PBXBuildFile; fileRef = 92ED54AF16AC27F0006A1C73 /* LICENSE.txt */; };
92ED54B216AC27F0006A1C73 /* README.md in Resources */ = {isa = PBXBuildFile; fileRef = 92ED54B016AC27F0006A1C73 /* README.md */; };
+ 92EE065B16D33F9100D3A01D /* editorMenu.jpg in Resources */ = {isa = PBXBuildFile; fileRef = 92EE065A16D33F9100D3A01D /* editorMenu.jpg */; };
92EEEEDB16BF57DA007610B9 /* Doxyfile in Resources */ = {isa = PBXBuildFile; fileRef = 92EEEE7C16BF57DA007610B9 /* Doxyfile */; };
ECE9A478150A435E0076F0C5 /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = ECE9A477150A435E0076F0C5 /* UIKit.framework */; };
ECE9A47A150A435E0076F0C5 /* Foundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = ECE9A479150A435E0076F0C5 /* Foundation.framework */; };
@@ -46,6 +47,7 @@
92EC8ECC16C0BBC20087B43B /* mainpage.dox */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = mainpage.dox; sourceTree = "<group>"; };
92ED54AF16AC27F0006A1C73 /* LICENSE.txt */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = LICENSE.txt; sourceTree = "<group>"; };
92ED54B016AC27F0006A1C73 /* README.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = README.md; sourceTree = "<group>"; };
+ 92EE065A16D33F9100D3A01D /* editorMenu.jpg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = editorMenu.jpg; sourceTree = "<group>"; };
92EEEE7C16BF57DA007610B9 /* Doxyfile */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = Doxyfile; sourceTree = "<group>"; };
ECE9A473150A435E0076F0C5 /* ADVProgressBar.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = ADVProgressBar.app; sourceTree = BUILT_PRODUCTS_DIR; };
ECE9A477150A435E0076F0C5 /* UIKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = UIKit.framework; path = System/Library/Frameworks/UIKit.framework; sourceTree = SDKROOT; };
@@ -93,6 +95,7 @@
92EC8ECF16C0C92C0087B43B /* Resources */ = {
isa = PBXGroup;
children = (
+ 92EE065A16D33F9100D3A01D /* editorMenu.jpg */,
92972F2F16D0ACD8009F08AA /* storyboard0.jpg */,
92972F3016D0ACD8009F08AA /* storyboard1.jpg */,
92972F3116D0ACD8009F08AA /* storyboard2.jpg */,
@@ -268,6 +271,7 @@
92972F3216D0ACD8009F08AA /* storyboard0.jpg in Resources */,
92972F3316D0ACD8009F08AA /* storyboard1.jpg in Resources */,
92972F3416D0ACD8009F08AA /* storyboard2.jpg in Resources */,
+ 92EE065B16D33F9100D3A01D /* editorMenu.jpg in Resources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
View
2 DoxyDoc/Doxyfile
@@ -1186,7 +1186,7 @@ DISABLE_INDEX = NO
# Since the tree basically has the same information as the tab index you
# could consider to set DISABLE_INDEX to NO when enabling this option.
-GENERATE_TREEVIEW = YES
+GENERATE_TREEVIEW = NO
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
View
BIN DoxyDoc/Resources/storyboard0.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN DoxyDoc/Resources/storyboard2.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
61 DoxyDoc/mainpage.dox
@@ -6,11 +6,8 @@
/*
The MIT License
- Original work Copyright (c) 2011 Tope Abayomi
- http://www.appdesignvault.com/
-
- Modified work Copyright (c) 2013 Corrado Ubezio
- https://github.com/corerd/
+ Copyright (c) 2013 Corrado Ubezio
+ https://github.com/corerd/
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
@@ -34,50 +31,70 @@
/*!
@mainpage Design documentation
- Define a Custom UIView to depict the progress of a task over time.
+ Define the `ADVPercentProgressBar` class, that is a Custom UIView to depict
+ the progress of a task over time.
The amount of **progress** is displayed by a multiple colors horizontal bar
that represents a range of values.
- The current **progress** is shown by the position of a cursor with a textual
- indication of the amount of the task that has completed, as its value or
- percentage:
+ The current **progress** is shown by the position of a cursor with the textual
+ indication of the amount of the task that has completed. The amount can be
+ displayed as integral value or a percentage of it.
+
+ The `ADVPercentProgressBar` class can be created and instantiated both in-code
+ (programmatically) or via a nib (storyboard).
+
+
+ Using the `ADVPercentProgressBar` Custom UIView
+ -----------------------------------------------
+ The `ADVPercentProgressBar` class is deployed together a demo app to show
+ various use case scenarios.
@image html screenshot.jpg
- Using the ADVPercentProgressBar View
- ------------------------------------
+ The custom UIView class and the demo app have been developed as an Xcode 4.5.2
+ project for iPhone devices targeting iOS 5.0.
- This Custom UIView can be created and instantiated both in-code
- (programmatically) or via a nib (storyboard).
+ To achieve the same demo app yourself, open Xcode and create a new project
+ with the iOS\Application\Single View Application template and
+ name it ADVProgressBar.
+ Enter ADV as Class Prefix; make sure the Device Family is set to iPhone,
+ Use Storyboard and Use Automatic Reference Counting are checked.
+
+ Add `ADVPercentProgressBar.h` and `ADVPercentProgressBar.m` to your project.
Open MainStoryboard.storyboard and go to Editor\Canvas\Show Bounds Rectangles
(this will make it easier to see what we’re doing).
+ @image html editorMenu.jpg
Then drag a UIView from the Object Library into the view controller,
and resize it to look like the following:
@image html storyboard0.jpg
Then click on the UIView you added and go to the Identity Inspector.
- Set the class to ADVPercentProgressBar:
+ Set the class to `ADVPercentProgressBar`:
@image html storyboard1.jpg
Now connect this to outlets. Bring up the Assistant editor, and make sure that
- ADVViewController.h is visible and import the ADVPercentProgressBar header.
+ ADVViewController.h is visible and import the `ADVPercentProgressBar` header.
Control-drag from the UIView down between the \@interface and \@end lines,
- and connect it to an Outlet named as you like, say myCustomProgressBar.
+ connect it to an Outlet and named it `pbRangeValue`.
@image html storyboard2.jpg
- Repeat this for any other ADVPercentProgressBar views you have to add.
+ Repeat this for an other `ADVPercentProgressBar` views, but connect it
+ to an outlet called `pbRangePercent`.
At this point ADVViewController.h should look like the following:
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+\code
#import <UIKit/UIKit.h>
#import "ADVPercentProgressBar.h"
-\@interface ADVViewController : UIViewController
+@interface ADVViewController : UIViewController
+
+@property (weak, nonatomic) IBOutlet ADVPercentProgressBar *pbRangeValue;
+@property (weak, nonatomic) IBOutlet ADVPercentProgressBar *pbRangePercent;
-\@property (weak, nonatomic) IBOutlet ADVPercentProgressBar *myCustomProgressBar;
+-(IBAction)sliderValueChanged:(UISlider*)sender;
-\@end
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+@end
+\endcode
*/
View
54 README.md
@@ -1,31 +1,38 @@
ADVProgressBar for iOS
======================
-A custom progress bar that comes in multiple colors.
+Define the `ADVPercentProgressBar` class, that is a custom progress bar
+that comes in multiple colors.
It shows a display above the bar that depicts the amount of the task that has
-completed.
-This indication may be displayed as the whole value or its percentage.
+completed. This indication may be displayed as the whole value or its percentage.
-This work has been derived from https://github.com/appdesignvault/ADVProgressBar.
+The `ADVPercentProgressBar` class is deployed together a demo app to show
+various use case scenarios. They have been developed as an Xcode 4.5.2 project
+targeting iOS 5.0.
+
+This work has been derived from
+https://github.com/appdesignvault/ADVProgressBar.
Changes relate to the following topics:
- Let configure the range of the values represented by the progress bar.
- Choose the way the amount of completed task is displayed: percentage or integral.
- Allow variable size.
- Add support to `initWithFrame` and `initWithCoder` so that the view controller
- can add `ADVProgressBar` via a nib (storyboard) or programatically.
+ can add `ADVPercentProgressBar` class via a nib (storyboard) or programatically.
- Annotate source code files an according to Doxygen in order to auto generate
- design documentation.
+ design documentation.
+- A tutorial has been added.
DOCUMENTATION
-------------
-The design documentation can be found [here] (http://corerd.github.com/ADVProgressBar).
+The design documentation can be found [here](http://corerd.github.com/ADVProgressBar).
+
+The Doxygen configuration file Doxyfile is also provided. The Doxygen output
+html pages can be found under the **gh-pages** branch. Otherwise, you can self
+generate them following these steps:
-The Doxygen configuration file Doxyfile is also provided.
-The Doxygen output html pages can be found under the **gh-pages** branch.
-Otherwise, you can self generate them following these steps:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cd /path/to/ADVProgressBar/DoxyDoc
doxygen Doxyfile
@@ -49,22 +56,21 @@ Original work Copyright (c) 2011 Tope Abayomi
Modified work Copyright (c) 2013 Corrado Ubezio
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 comments on commit b8b9692

Please sign in to comment.