#67 Some api document updates.

karma4u101 · Apr 18, 2016 · 526769f · 526769f
1 parent f3a0da1
commit 526769f
Show file tree

Hide file tree

Showing 13 changed files with 33 additions and 70 deletions.
diff --git a/Angular/AngularJS-API/src/main/scala/net/liftmodules/FoBoAJS/FoBoAJSAPI.scala b/Angular/AngularJS-API/src/main/scala/net/liftmodules/FoBoAJS/FoBoAJSAPI.scala
@@ -6,16 +6,12 @@ import http._
 import common._
 
 /**
- * ==FoBo API sub-module== 
- * This package object provides module initiation in FoBo's most fine grain level. 
+ * ==FoBo AngularJS API Module== 
  * 
- * This is useful if you want to depend on a small subset of FoBo's functionality 
- * by only pulling in some specific FoBo artifact(s) that provides toolkit resources
- * or FoBo API functions.
- * 
- * This module provides initiation of API functions for the Angular module.
- *  
- * For more information on how to set up and use the FoBo modules see the FoBo readme. 
+ * This FoBo API module provides FoBo/Lift API components for the AngularJS Toolkit Module, 
+ * but can also be used as-is, see below for setup information.
+ *
+ * If you are using this module via the FoBo/FoBo module see also [[net.liftmodules.FoBo]] for setup information. 
  */
 package object FoBoAJSAPI {
 

diff --git a/Angular/AngularJS-API/src/main/scala/net/liftmodules/FoBoAJS/lib/AJSMaterialSH.scala b/Angular/AngularJS-API/src/main/scala/net/liftmodules/FoBoAJS/lib/AJSMaterialSH.scala
@@ -4,6 +4,7 @@ import net.liftweb.util._
 
 /**
  * ==Angular Material Design Script Helper==
+ * 
  * Angular Material Design script helper is a helper class that implements some commonly 
  * used material design component script functions.
  * 

diff --git a/Angular/AngularJS-Res/README.md b/Angular/AngularJS-Res/README.md
@@ -1,7 +1,7 @@
 # FoBo AngularJS Resource Module
 
-This resource module provides AngularJS resource components to the FoBo AngularJS Toolkit module, but can also be used as-is 
-(see below for setup information).
+This resource module provides AngularJS resource components to the FoBo AngularJS Toolkit module, 
+but can also be used as-is, see below for setup information.
 
 ### Lift FoBo boot hooks (when used in the FoBo module)
 

diff --git a/Angular/AngularJS-Res/src/main/scala/net/liftmodules/FoBoAJS/FoBoAJSRes.scala b/Angular/AngularJS-Res/src/main/scala/net/liftmodules/FoBoAJS/FoBoAJSRes.scala
@@ -6,16 +6,13 @@ import http._
 import common._
 
 /**
- * ==FoBo Resource sub-module==
- * This package object provides module initiation in FoBo's most fine grain level.
- *
- * This is useful if you want to depend on a small subset of FoBo's functionality
- * by only pulling in some specific FoBo artifact(s) that provides toolkit resources
- * or FoBo API functions.
- *
- * This module provides toolkit resources for the Angular module.
- *
- * For more information on how to set up and use the FoBo modules see the FoBo readme.
+ * ==FoBo AngularJS Resource Module==
+ * 
+ * This resource module provides AngularJS resource components to the FoBo AngularJS Toolkit module, 
+ * but can also be used as-is, see below for setup information.
+ * 
+ * If you are using this module via the FoBo/FoBo module see also [[net.liftmodules.FoBo]] for setup information. 
+ * 
  */
 package object FoBoAJSRes {
 

diff --git a/Angular/AngularJS/src/main/scala/net/liftmodules/FoBoAJS/FoBoAJS.scala b/Angular/AngularJS/src/main/scala/net/liftmodules/FoBoAJS/FoBoAJS.scala
@@ -6,16 +6,11 @@ import http._
 import common._
 
 /**
- * ==FoBo Toolkit sub-module== 
- * This package object provides Angular integration into your Lift/FoBo application.
+ * ==FoBo AngularJS Toolkit Module== 
+ * This FoBo toolkit module provides AngularJS API and Resource components to the FoBo Module, 
+ * but can also be used as-is, see below for setup information.
  * 
- * This package object is only of interest to you if you are using this module 
- * as a stand alone artifact dependency in your project (without the FoBo meta artifact).
- * This package object provides information on how to initiate and use it 
- * in your project. 
- * 
- * If you are using this module via the FoBo meta artifact 
- * see [[net.liftmodules.FoBo]] for usage information. 
+ * If you are using this module via the FoBo/FoBo module see also [[net.liftmodules.FoBo]] for setup information. 
  */
 package object FoBoAJS {
 

diff --git a/...ap/Bootstrap2/Twitter-Bootstrap-API/src/main/scala/net/liftmodules/FoBoTB/FoBoTBAPI.scala b/...ap/Bootstrap2/Twitter-Bootstrap-API/src/main/scala/net/liftmodules/FoBoTB/FoBoTBAPI.scala
@@ -6,16 +6,13 @@ import http._
 import common._
 
 /**
- * ==FoBo API sub-module==
- * This package object provides module initiation in FoBo's most fine grain level.
+ * ==FoBo Twitter Bootstrap API Module==
+ * 
+ * This FoBo API module provides FoBo/Lift API components for the Twitter Bootstrap v2.x Toolkit Module, 
+ * but can also be used as-is, see below for setup information.
  *
- * This is useful if you want to depend on a small subset of FoBo's functionality
- * by only pulling in some specific FoBo artifact(s) that provides toolkit resources
- * or FoBo API functions.
- *
- * This module provides initiation of API functions for the Bootstrap2 module.
- *
- * For more information on how to set up and use the FoBo modules see the FoBo readme.
+ * If you are using this module via the FoBo/FoBo artifact module see also [[net.liftmodules.FoBo]] for setup information.
+ * 
  */
 package object FoBoTBAPI {
 

diff --git a/Bootstrap/Bootstrap2/Twitter-Bootstrap/src/main/scala/net/liftmodules/FoBoTB/FoBoTB.scala b/Bootstrap/Bootstrap2/Twitter-Bootstrap/src/main/scala/net/liftmodules/FoBoTB/FoBoTB.scala
@@ -6,11 +6,12 @@ import http._
 import common._
 
 /**
- * ==FoBo Toolkit sub-module==
- * This package object provides Bootstrap 2 integration into your Lift/FoBo application.
+ * ==FoBo Twitter Bootstrap Toolkit Module==
+ * 
+ * This FoBo toolkit module provides Twitter Bootstrap v2.x API and Resource components to the 
+ * FoBo / FoBo Module, but can also be used as-is, see below for setup information.
  *
- * If you are using this module via the FoBo/FoBo artifact module
- * see [[net.liftmodules.FoBo]] for initiation information.
+ * If you are using this module via the FoBo/FoBo artifact module see also [[net.liftmodules.FoBo]] for setup information.
  * 
  * @example To initiate this module for usage in your Lift project set something like the following in 
  * your projects Lift bootstrap.liftweb.Boot boot method. 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,9 +21,7 @@ For update history see the [History log](https://github.com/karma4u101/FoBo/tree
 See [Development branch](https://github.com/karma4u101/FoBo/tree/develop/CHANGELOG.md)
 
 **Latest Snapshot Release:**
-- **2016-03-30** -- 1.6-SNAPSHOT release for Lift v3.0 and v2.6.2
-- **2016-03-25** -- 1.6-SNAPSHOT release for Lift v3.0 and v2.6.2
-See [Development branch](https://github.com/karma4u101/FoBo/tree/develop/CHANGELOG.md)
+- Snapshots is released regularly see [Sonatype quick search](https://oss.sonatype.org/#nexus-search;quick~fobo)
 
 FoBo v1.6
 ---------

diff --git a/FoBo/FoBo-API/src/main/scala/net/liftmodules/FoBo/snippet/FoBo/Info.scala b/FoBo/FoBo-API/src/main/scala/net/liftmodules/FoBo/snippet/FoBo/Info.scala
@@ -20,6 +20,7 @@ import net.liftmodules.FoBo.lib.BuildInfo //generated code
  * {{{ <span>vX.Y.Z</span> }}}  
  * For more examples see the individual transform functions.
  */
+
 object Info extends StatefulSnippet with Loggable {
 
 

diff --git a/FoBo/FoBo-API/src/main/scala/net/liftmodules/package.scala b/FoBo/FoBo-API/src/main/scala/net/liftmodules/package.scala
diff --git a/FoBo/FoBo-API/src/main/scala/net/package.scala b/FoBo/FoBo-API/src/main/scala/net/package.scala
diff --git a/FoBo/FoBo-API/src/main/scala/package.scala b/FoBo/FoBo-API/src/main/scala/package.scala
diff --git a/Pace/Pace/src/main/scala/net/liftmodules/FoBoPa/FoBoPa.scala b/Pace/Pace/src/main/scala/net/liftmodules/FoBoPa/FoBoPa.scala
@@ -27,7 +27,7 @@ package object FoBoPa {
 
   object ToolKit extends ToolKit {
     var Init: ToolKit = null 
-
+ 
    /**
      * Enable usage of FoBo's Pace API and resources version 1&#8228;0&#8228;2 in your bootstrap liftweb Boot.
      * @version 1.0.2
@@ -42,7 +42,6 @@ package object FoBoPa {
      */    
      case object Pace102 extends ToolKit {
        FoBoPaRes.Resource.Pace102
-       //FoBoPaAPI.API.Pace0
      }
 
    /**
@@ -59,7 +58,6 @@ package object FoBoPa {
      */    
      case object Pace0415 extends ToolKit {
        FoBoPaRes.Resource.Pace0415
-       //FoBoPaAPI.API.Pace0
      }    
   }
 
@@ -157,7 +155,6 @@ package object FoBoPa {
   @deprecated("Use FoBoPa.ToolKit.Init=FoBoPa.ToolKit.Pace0415","1.6.0")
   case object Pace0415 extends PaToolkit {
     ToolKit.Pace0415
-    //API.Pace0415
   }
 
   /**