Skip to content

Commit

Permalink
Add plist for configuring AppleDocs. Added documentation to header fi…
Browse files Browse the repository at this point in the history
…les.
  • Loading branch information
Luke Deniston authored and escoz committed Aug 16, 2013
1 parent d4ce1f9 commit 4db06af
Show file tree
Hide file tree
Showing 18 changed files with 109 additions and 0 deletions.
40 changes: 40 additions & 0 deletions AppledocSettings.plist
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>--company-id</key>
<string>com.escoz</string>
<key>--logformat</key>
<integer>1</integer>
<key>--project-name</key>
<string>QuickDialog</string>
<key>--project-company</key>
<string>Escoz</string>
<key>--print-settings</key>
<true/>
<key>--output</key>
<array>
<string>./docs</string>
</array>
<key>--keep-intermediate-files</key>
<false/>
<key>--create-html</key>
<true/>
<key>--keep-undocumented-members</key>
<true/>
<key>--keep-undocumented-objects</key>
<true/>
<key>--create-docset</key>
<false/>
<key>--ignore</key>
<array>
<string>./sample</string>
<string>./quickdialog/DOAutocompleteTextField.h</string>
<string>./quickdialog/DOAutocompleteTextField.m</string>
</array>
<key>--index-desc</key>
<string>./README.markdown</string>
<key>--verbose</key>
<integer>4</integer>
</dict>
</plist>
3 changes: 3 additions & 0 deletions extras/QMapElement.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@

#import "QRootElement.h"

/**
QMapElement: when selected, shows a fullscreen map with the location selected. Requires a lat/long value.
*/

@interface QMapElement : QRootElement {

Expand Down
4 changes: 4 additions & 0 deletions extras/QWebElement.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
#import <Foundation/Foundation.h>
#import "QLabelElement.h"

/**
QWebElement: pushes a simple browser that opens the URL defined in the element
*/

@interface QWebElement : QLabelElement {

@protected
Expand Down
4 changes: 4 additions & 0 deletions quickdialog/QBadgeElement.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
#import "QuickDialogTableView.h"
#import "QLabelElement.h"

/**
QBadgeElement: like the label cell, but the value is displayed with a badge, like the Mail app.
*/

@interface QBadgeElement : QLabelElement {

@private
Expand Down
4 changes: 4 additions & 0 deletions quickdialog/QBooleanElement.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@

#import "QLabelElement.h"

/**
QBooleanElement: shows a on/off switch
*/

@interface QBooleanElement : QLabelElement {
BOOL _boolValue;
BOOL _enabled;
Expand Down
4 changes: 4 additions & 0 deletions quickdialog/QButtonElement.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@

#import "QLabelElement.h"

/**
QButtonElement: centered title that looks like a button.
*/

@interface QButtonElement : QLabelElement

- (QButtonElement *)init;
Expand Down
3 changes: 3 additions & 0 deletions quickdialog/QDateTimeElement.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>

/**
QDateTimeElement: allows you to edit dates, time, or date+time values. Editing occurs in a new controller that is pushed automatically.
*/

@interface QDateTimeElement : QRootElement {
NSDate * _dateValue;
Expand Down
4 changes: 4 additions & 0 deletions quickdialog/QDecimalElement.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
#import <Foundation/Foundation.h>
#import "QEntryElement.h"

/**
QDecimalElement: very much like an entry field, but allows only numbers to be typed. Automatically limits numbers to a predefined number of decimal places.
*/

@interface QDecimalElement : QEntryElement {

}
Expand Down
6 changes: 6 additions & 0 deletions quickdialog/QElement.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@
@class QuickDialogTableView;
@class QuickDialogController;

/**
QElement – an element object maps one-to-one map to a UITableViewCell, although it includes more functionality, like being able to read values from the cells and having multiple types. QuickDialog provides many different built-in element types, like the ButtonElement and the EntryElement, but you can also create your custom one.
*/

@interface QElement : NSObject {

@protected
Expand Down
4 changes: 4 additions & 0 deletions quickdialog/QEntryElement.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@

@protocol QuickDialogEntryElementDelegate;

/**
QEntryElement: input field to allow you to collect values from the user. Automatically resizes so that all entries in the same sections look alike.
*/

@interface QEntryElement : QLabelElement <UITextInputTraits> {

@private
Expand Down
4 changes: 4 additions & 0 deletions quickdialog/QFloatElement.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
#import "QuickDialogTableView.h"
#import "QLabelElement.h"

/**
QFloatElement: shows an slider control.
*/

@interface QFloatElement : QLabelElement {

float _floatValue;
Expand Down
4 changes: 4 additions & 0 deletions quickdialog/QLabelElement.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@
#import <UIKit/UIKit.h>
#import "QRootElement.h"

/**
QLabelElement: simple inline label + value cell
*/

@interface QLabelElement : QRootElement {

@protected
Expand Down
4 changes: 4 additions & 0 deletions quickdialog/QRadioElement.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
#import "QuickDialogTableView.h"
#import "QEntryElement.h"

/**
QRadioElement: allows user to select one of multiple options available. Automatically pushes a new table with the item to be selected.
*/

@interface QRadioElement : QEntryElement {
NSArray *_items;
NSArray *_values;
Expand Down
4 changes: 4 additions & 0 deletions quickdialog/QRadioSection.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
#import "QSection.h"
#import "QSelectSection.h"

/**
QRadioSection: display multiple choice elements inline, instead of pushing another view controller with the options.
*/

@interface QRadioSection : QSelectSection

@property(nonatomic) NSInteger selected;
Expand Down
5 changes: 5 additions & 0 deletions quickdialog/QRootElement.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ typedef enum {
QPresentationModeModalPage
} QPresentationMode;

/**
Think of a root element as a dialog: a collection of sections and cells that can be used to display some useful data to the user. Every QuickDialogController can only display one RootElement at a time, although that RootElement can contain other root elements inside, which causes a new controller to automatically be displayed. Elements are always grouped in sections in the root element, as you can see below.
*/

@interface QRootElement : QElement {

@protected
Expand Down
4 changes: 4 additions & 0 deletions quickdialog/QSortingSection.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@

#import "QSection.h"

/**
QSortingSection: automatically enables sorting of the cells inside the section.
*/

@interface QSortingSection : QSection {

BOOL _sortingEnabled;
Expand Down
4 changes: 4 additions & 0 deletions quickdialog/QTextElement.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@

#import "QRootElement.h"

/**
QTextElement: freeform text, which is rendered with the font provided.
*/

@interface QTextElement : QRootElement {

@protected
Expand Down
4 changes: 4 additions & 0 deletions quickdialog/QuickDialogController.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@
@class QRootElement;
@class QuickDialogTableView;

/**
QuickDialogController is a subclass of a UITableViewController that is responsible for actually displaying the dialog. For your application, you’ll very likely be creating subclasses of this class, one for each dialog you own. You’ll never really have to create objects of this type directly with alloc/init. The framework takes care of this for you.
*/

@interface QuickDialogController : UIViewController <UIPopoverControllerDelegate> {

@private
Expand Down

0 comments on commit 4db06af

Please sign in to comment.