boa 0.2.0 → 0.2.1

data/README.md

@@ -28,6 +28,9 @@ boa module create Example
 
 ## Changes
 
+#### v0.2.1
+  * added basic appledoc comments for interfaces and protocols
+
 #### v0.2.0
   * added class prefix option
 

data/lib/boa/module/templates/DataManager.h

@@ -8,6 +8,9 @@
 
 #import <Foundation/Foundation.h>
 
+/**
+ Data manager for the <%= @module %> module.
+ */
 @interface <%= @prefixed_module %>DataManager : NSObject
 
 @end

data/lib/boa/module/templates/Interactor.h

@@ -13,6 +13,9 @@
 
 @class <%= @prefixed_module %>Presenter;
 
+/**
+ Business logic for the <%= @module %> module.
+ */
 @interface <%= @prefixed_module %>Interactor : NSObject
 
 @property (nonatomic, strong) <%= @prefixed_module %>Presenter *presenter;

data/lib/boa/module/templates/ModuleInterface.h

@@ -8,10 +8,16 @@
 
 #import <Foundation/Foundation.h>
 
+/**
+ Module interface for the <%= @module %> module.
+ */
 @protocol <%= @prefixed_module %>ModuleInterface <NSObject>
 
 @end
 
+/**
+ Module delegate for the <%= @module %> module.
+ */
 @protocol <%= @prefixed_module %>ModuleDelegate <NSObject>
 
 @end

data/lib/boa/module/templates/Presenter.h

@@ -17,6 +17,9 @@
 @class <%= @prefixed_module %>Wireframe;
 @class <%= @prefixed_module %>Interactor;
 
+/**
+ Display logic for the <%= @module %> module.
+ */
 @interface <%= @prefixed_module %>Presenter : NSObject <<%= @prefixed_module %>ModuleInterface>
 
 @property (nonatomic, strong) <%= @prefixed_module %>Interactor *interactor;

data/lib/boa/module/templates/ViewController.h

@@ -11,6 +11,9 @@
 #import "<%= @prefixed_module %>ModuleInterface.h"
 #import "<%= @prefixed_module %>ViewInterface.h"
 
+/**
+ View controller for the <%= @module %> module.
+ */
 @interface <%= @prefixed_module %>ViewController : UIViewController <<%= @prefixed_module %>ViewInterface>
 
 @property (nonatomic, strong) id<<%= @prefixed_module %>ModuleInterface> eventHandler;

data/lib/boa/module/templates/ViewInterface.h

@@ -8,6 +8,9 @@
 
 #import <Foundation/Foundation.h>
 
+/**
+ View interface for the <%= @module %> module.
+ */
 @protocol <%= @prefixed_module %>ViewInterface <NSObject>
 
 @end

data/lib/boa/module/templates/Wireframe.h

@@ -13,6 +13,9 @@
 
 @class <%= @prefixed_module %>Presenter;
 
+/**
+ Module wireframe for the <%= @module %> module.
+ */
 @interface <%= @prefixed_module %>Wireframe : NSObject
 
 @property (nonatomic, strong) RootWireframe *rootWireframe;

data/lib/boa/templates/AppDelegate.h

@@ -8,6 +8,9 @@
 
 #import <UIKit/UIKit.h>
 
+/**
+ App delegate for the <%= @project %> project.
+ */
 @interface <%= @project %>AppDelegate : UIResponder <UIApplicationDelegate>
 
 @property (strong, nonatomic) UIWindow *window;

data/lib/boa/templates/AppDependencies.h

@@ -9,6 +9,9 @@
 #import <Foundation/Foundation.h>
 #import <UIKit/UIKit.h>
 
+/**
+ Dependency hierarchy for the <%= @project %> project.
+ */
 @interface <%= @project %>AppDependencies : NSObject
 
 - (id)initWithWindow:(UIWindow *)window;

data/lib/boa/templates/RootWireframe.h

@@ -9,6 +9,9 @@
 #import <UIKit/UIKit.h>
 #import <Foundation/Foundation.h>
 
+/**
+ Root wireframe for the <%= @project %> project.
+ */
 @interface RootWireframe : NSObject
 
 - (id)initWithWindow:(UIWindow *)window;

data/lib/boa/version.rb

@@ -1,3 +1,3 @@
 module Boa
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boa
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors: