#67 Update of api documentation.

karma4u101 · Apr 20, 2016 · 51172a9 · 51172a9
1 parent 74e0971
commit 51172a9
Show file tree

Hide file tree

Showing 23 changed files with 187 additions and 222 deletions.
diff --git a/Angular/AngularJS/src/main/scala/net/liftmodules/FoBoAJS/FoBoAJS.scala b/Angular/AngularJS/src/main/scala/net/liftmodules/FoBoAJS/FoBoAJS.scala
@@ -17,6 +17,7 @@ package object FoBoAJS {
   override def toString() = {
     FoBoAJS.ToolKit.toString()+" "+FoBoAJS.Resource.toString()+" "+FoBoAJS.API.toString()
   }  
+
   /**
    * Initiate FoBo's Angular ToolKit(s) in you bootstrap liftweb Boot.
    * Using the ToolKit initiation you will bring in both the 
@@ -29,7 +30,8 @@ package object FoBoAJS {
    *    :
    *   FoBo.ToolKit.Init=FoBo.ToolKit.[ToolKit Object]
    * }}}
-   */
+   * '''Note:''' To see available objects click on the round trait icon in the header of this page.
+   */  
   abstract sealed trait ToolKit
 
   /**
@@ -41,6 +43,7 @@ package object FoBoAJS {
    *    :
    *   FoBo.Resource.Init=FoBo.Resource.[Resource Object]
    * }}}
+   * '''Note:''' To see available objects click on the round trait icon in the header of this page.
    */  
   abstract sealed trait Resource
 
@@ -53,6 +56,7 @@ package object FoBoAJS {
    *    :
    *   FoBo.API.Init=FoBo.API.[API Object]
    * }}}
+   * '''Note:''' To see available objects click on the round trait icon in the header of this page.
    */    
   abstract sealed trait API
 
@@ -786,6 +790,7 @@ package object FoBoAJS {
    * }}}
    * @since v1.5
    */
+  @deprecated("Use FoBoAJS.ToolKit.Init=FoBoAJS.ToolKit.AngularJS148","1.6.0")
   case object AngularJS148 extends FoBoToolkit {
     ToolKit.AngularJS148
   } 
@@ -803,6 +808,7 @@ package object FoBoAJS {
    * }}}
    * @since v1.5
    */
+  @deprecated("Use FoBoAJS.ToolKit.Init=FoBoAJS.ToolKit.AngularJS148i18n","1.6.0")
   case object AngularJS148i18n extends FoBoToolkit {
     ToolKit.AngularJS148i18n
   } 
@@ -821,6 +827,7 @@ package object FoBoAJS {
    * }}}
    * @since v1.4
    */
+  @deprecated("Use FoBoAJS.ToolKit.Init=FoBoAJS.ToolKit.AngularJS141","1.6.0")
   case object AngularJS141 extends FoBoToolkit {
     ToolKit.AngularJS141
   } 
@@ -838,6 +845,7 @@ package object FoBoAJS {
    * }}}
    * @since v1.4
    */
+  @deprecated("Use FoBoAJS.ToolKit.Init=FoBoAJS.ToolKit.AngularJS141i18n","1.6.0")
   case object AngularJS141i18n extends FoBoToolkit {
     ToolKit.AngularJS141i18n
   } 
@@ -855,6 +863,7 @@ package object FoBoAJS {
    * }}}
    * @since v1.4
    */
+  @deprecated("Use FoBoAJS.ToolKit.Init=FoBoAJS.ToolKit.AngularJS1315","1.6.0")
   case object AngularJS1315 extends FoBoToolkit {
     ToolKit.AngularJS1315
   } 
@@ -872,6 +881,7 @@ package object FoBoAJS {
    * }}}
    * @since v1.4
    */
+  @deprecated("Use FoBoAJS.ToolKit.Init=FoBoAJS.ToolKit.AngularJS1315i18n","1.6.0")
   case object AngularJS1315i18n extends FoBoToolkit {
     ToolKit.AngularJS1315i18n
   }   
@@ -890,6 +900,7 @@ package object FoBoAJS {
    * }}}
    * @since v1.3
    */
+  @deprecated("Use FoBoAJS.ToolKit.Init=FoBoAJS.ToolKit.AngularJS1219","1.6.0")
   case object AngularJS1219 extends FoBoToolkit {
     ToolKit.AngularJS1219
   } 
@@ -907,6 +918,7 @@ package object FoBoAJS {
    * }}}
    * @since v1.3
    */
+  @deprecated("Use FoBoAJS.ToolKit.Init=FoBoAJS.ToolKit.AngularJS1219i18n","1.6.0")
   case object AngularJS1219i18n extends FoBoToolkit {
     ToolKit.AngularJS1219i18n
   } 
@@ -943,6 +955,7 @@ package object FoBoAJS {
    * }}}
    * @since v1.5
    */
+  @deprecated("Use FoBoAJS.ToolKit.Init=FoBoAJS.ToolKit.AJMaterial101","1.6.0")
   case object AJMaterial101 extends FoBoToolkit {
     ToolKit.AJMaterial101
   }  
@@ -960,6 +973,7 @@ package object FoBoAJS {
    * }}}
    * @since v1.6
    */
+  @deprecated("Use FoBoAJS.ToolKit.Init=FoBoAJS.ToolKit.AJMaterial107","1.6.0")
   case object AJMaterial107 extends FoBoToolkit {
     ToolKit.AJMaterial107
   }   
@@ -977,6 +991,7 @@ package object FoBoAJS {
    * }}}
    * @since v1.2
    */
+  @deprecated("Use FoBoAJS.ToolKit.Init=FoBoAJS.ToolKit.AJSUIBootstrap0100","1.6.0")
   case object AJSUIBootstrap0100 extends FoBoToolkit {
     ToolKit.AJSUIBootstrap0100
   }   
@@ -994,6 +1009,7 @@ package object FoBoAJS {
    * }}}
    * @since v1.2
    */
+  @deprecated("Use FoBoAJS.ToolKit.Init=FoBoAJS.ToolKit.AJSUIBootstrap070","1.6.0")
   case object AJSUIBootstrap070 extends FoBoToolkit {
     ToolKit.AJSUIBootstrap070
   }   
@@ -1011,6 +1027,7 @@ package object FoBoAJS {
    * }}}
    * @since v1.0
    */
+  @deprecated("Use FoBoAJS.ToolKit.Init=FoBoAJS.ToolKit.AJSUIBootstrap020","1.6.0")
   case object AJSUIBootstrap020 extends FoBoToolkit {
     ToolKit.AJSUIBootstrap020
   }   
@@ -1029,6 +1046,7 @@ package object FoBoAJS {
    * }}}
    * @since v1.2
    */
+  @deprecated("Use FoBoAJS.ToolKit.Init=FoBoAJS.ToolKit.AJSNGGrid207","1.6.0")
   case object AJSNGGrid207 extends FoBoToolkit {
     ToolKit.AJSNGGrid207
   }
@@ -1046,6 +1064,7 @@ package object FoBoAJS {
    * }}}
    * @since v1.5
    */
+  @deprecated("Use FoBoAJS.ToolKit.Init=FoBoAJS.ToolKit.AJSUIGrid307","1.6.0")
   case object AJSUIGrid307 extends FoBoToolkit {
     ToolKit.AJSUIGrid307
   }  

diff --git a/...ap/Bootstrap2/Twitter-Bootstrap-Res/src/main/scala/net/liftmodules/FoBoTB/FoBoTBRes.scala b/...ap/Bootstrap2/Twitter-Bootstrap-Res/src/main/scala/net/liftmodules/FoBoTB/FoBoTBRes.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.
+ * ==FoBo Twitter Bootstrap Resource Module==
+ * 
+ * This resource module provides Twitter Bootstrap resource components to the FoBo Twitter Bootstrap 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. 
  *
- * 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 Bootstrap v2.x module.
- *
- * For more information on how to set up and use the FoBo modules see the FoBo readme.
  */
 package object FoBoTBRes {
 

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
@@ -40,9 +40,9 @@ package object FoBoTB {
    * {{{
    *   import net.liftmodules.{FoBoTB => FoBo}
    *    :
-   *   FoBo.ToolKit.Init=FoBo.ToolKit.[ToolKit Companion Object]
+   *   FoBo.ToolKit.Init=FoBo.ToolKit.[ToolKit Object]
    * }}}
-   * '''Note:''' To see available companion objects click on the round trait icon in the header of this page.
+   * '''Note:''' To see available objects click on the round trait icon in the header of this page.
    *  
    */
   abstract sealed trait ToolKit
@@ -54,9 +54,9 @@ package object FoBoTB {
    * {{{
    *   import net.liftmodules.{FoBoTB => FoBo}
    *    :
-   *   FoBo.Resource.Init=FoBo.Resource.[Resource Companion Object]
+   *   FoBo.Resource.Init=FoBo.Resource.[Resource Object]
    * }}}
-   * '''Note:''' To see available companion objects click on the round trait icon in the header of this page.
+   * '''Note:''' To see available objects click on the round trait icon in the header of this page.
    */
   abstract sealed trait Resource
 
@@ -67,9 +67,9 @@ package object FoBoTB {
    * {{{
    *   import net.liftmodules.{FoBoTB => FoBo}
    *    :
-   *   FoBo.API.Init=FoBo.API.[API Compainion Object]
+   *   FoBo.API.Init=FoBo.API.[API Object]
    * }}}
-   * '''Note:''' To see available companion objects click on the round trait icon in the header of this page.
+   * '''Note:''' To see available objects click on the round trait icon in the header of this page.
    */
   abstract sealed trait API
 
@@ -301,40 +301,12 @@ package object FoBoTB {
    *   FoBoTB.InitParam.Toolkit=FoBoTB.Bootstrap232
    * }}}
    */
+  @deprecated("Use FoBoTB.ToolKit.Init=FoBoTB.ToolKit.Bootstrap232", "1.6.0")
   case object Bootstrap232 extends FoBoToolkit {
     net.liftmodules.FoBoTBRes.Resource.Bootstrap232
     net.liftmodules.FoBoTBAPI.API.Bootstrap2
   }
 
-  private object FoBoAPI {
-    lazy val init: Unit = {
-      LiftRules.addToPackages("net.liftmodules.FoBoAJS")
-    }
-  }
-
-  /**
-   * Object holding internally used FoBo resources.
-   */
-  private object FoBoResources {
-
-    lazy val init: Unit = {
-      ResourceServer.allow {
-        case "fobo" :: tail => true
-      }
-    }
-
-    lazy val bootstrap232: Unit = {
-      ResourceServer.rewrite {
-        case "fobo" :: "bootstrap.css" :: Nil if Props.devMode            => List("fobo", "bootstrap", "2.3.2", "css", "bootstrap.css")
-        case "fobo" :: "bootstrap.css" :: Nil                             => List("fobo", "bootstrap", "2.3.2", "css", "bootstrap-min.css")
-        case "fobo" :: "bootstrap-responsive.css" :: Nil if Props.devMode => List("fobo", "bootstrap", "2.3.2", "css", "responsive.css")
-        case "fobo" :: "bootstrap-responsive.css" :: Nil                  => List("fobo", "bootstrap", "2.3.2", "css", "responsive-min.css")
-        case "fobo" :: "bootstrap.js" :: Nil if Props.devMode             => List("fobo", "bootstrap", "2.3.2", "js", "bootstrap.js")
-        case "fobo" :: "bootstrap.js" :: Nil                              => List("fobo", "bootstrap", "2.3.2", "js", "bootstrap-min.js")
-      }
-    }
-
-  }
 
 }
 
diff --git a/...trap/Bootstrap3/TwBs-Bootstrap3-API/src/main/scala/net/liftmodules/FoBoBs/FoBoBsAPI.scala b/...trap/Bootstrap3/TwBs-Bootstrap3-API/src/main/scala/net/liftmodules/FoBoBs/FoBoBsAPI.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 Bootstrap 3 API Module==
+ * 
+ * This FoBo API module provides FoBo/Lift API components for the Bootstrap v3.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 Bootstrap3 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 FoBoBsAPI {
 

diff --git a/...trap/Bootstrap3/TwBs-Bootstrap3-Res/src/main/scala/net/liftmodules/FoBoBs/FoBoBsRes.scala b/...trap/Bootstrap3/TwBs-Bootstrap3-Res/src/main/scala/net/liftmodules/FoBoBs/FoBoBsRes.scala
@@ -7,16 +7,13 @@ import common._
 
 
 /**
- * ==FoBo Resource sub-module== 
- * This package object provides module initiation in FoBo's most fine grain level. 
+ * ==FoBo Bootstrap 3 Resource 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 resource module provides Bootstrap resource components to the FoBo Bootstrap 3 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. 
  * 
- * This module provides toolkit resources for the Bootstrap3 module.
- *  
- * For more information on how to set up and use the FoBo modules see the FoBo readme.
  */
 package object FoBoBsRes {
 

diff --git a/Bootstrap/Bootstrap3/TwBs-Bootstrap3/src/main/scala/net/liftmodules/FoBoBs/FoBoBs.scala b/Bootstrap/Bootstrap3/TwBs-Bootstrap3/src/main/scala/net/liftmodules/FoBoBs/FoBoBs.scala
@@ -7,12 +7,13 @@ import common._
 
 
 /**
- * ==FoBo Toolkit sub-module== 
- * This package object provides Bootstrap 3 integration into your Lift/FoBo application.
+ * ==FoBo Bootstrap 3 Toolkit Module==
  * 
+ * This FoBo toolkit module provides Bootstrap v3.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 also [[net.liftmodules.FoBo]] for setup information.
  * 
- * If you are using this module via the FoBo meta artifact 
- * see [[net.liftmodules.FoBo]] for usage 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. 
@@ -450,6 +451,7 @@ object InitParam extends FoBoToolkit {
  * }}}
  * @since v1.5
  */
+@deprecated("Use FoBoBs.ToolKit.Init=FoBoBs.ToolKit.Bootstrap336","1.6.0")
 case object Bootstrap336 extends FoBoToolkit {
   net.liftmodules.FoBoBsRes.Resource.Bootstrap336
   net.liftmodules.FoBoBsAPI.API.Bootstrap3
@@ -485,6 +487,7 @@ case object Bootstrap335 extends FoBoToolkit {
  *   FoBoBs.InitParam.Toolkit=FoBoBs.Bootstrap320
  * }}}
  */
+@deprecated("Use FoBoBs.ToolKit.Init=FoBoBs.ToolKit.Bootstrap320","1.6.0")
 case object Bootstrap320 extends FoBoToolkit {
   net.liftmodules.FoBoBsRes.Resource.Bootstrap320
   net.liftmodules.FoBoBsAPI.API.Bootstrap3    
@@ -500,6 +503,7 @@ case object Bootstrap320 extends FoBoToolkit {
  *   FoBoBs.InitParam.Toolkit=FoBoBs.Bootstrap311
  * }}}
  */
+@deprecated("Use FoBoBs.ToolKit.Init=FoBoBs.ToolKit.Bootstrap311","1.6.0")
 case object Bootstrap311 extends FoBoToolkit {
   net.liftmodules.FoBoBsRes.Resource.Bootstrap311
   net.liftmodules.FoBoBsAPI.API.Bootstrap3   
@@ -516,6 +520,7 @@ case object Bootstrap311 extends FoBoToolkit {
  *   FoBoBs.InitParam.Toolkit=FoBoBs.Bootstrap301
  * }}}
  */
+@deprecated("Use FoBoBs.ToolKit.Init=FoBoBs.ToolKit.Bootstrap301","1.6.0")
 case object Bootstrap301 extends FoBoToolkit {
   net.liftmodules.FoBoBsRes.Resource.Bootstrap301
   net.liftmodules.FoBoBsAPI.API.Bootstrap3     

diff --git a/FoBo/FoBo-API/src/main/scala/net/liftmodules/FoBo/FoBoAPI.scala b/FoBo/FoBo-API/src/main/scala/net/liftmodules/FoBo/FoBoAPI.scala
@@ -6,11 +6,12 @@ import http._
 import common._
 
 /**
-* ==FoBo API sub-module==
+* ==FoBo / FoBo API Module==
 *
-* This module provides initiation of API functions for the FoBo module.
-*
-* For more information on how to set up and use the FoBo modules see the FoBo readme.
+ * This FoBo / FoBo API module provides FoBo/Lift API components for the FoBo Module, 
+ * but can also be used as-is.
+ *
+ * If you are using this module via the FoBo/FoBo module see also [[net.liftmodules.FoBo]] for setup information.
 */
 package object FoBoAPI {