#67 Documentation update.

karma4u101 · Apr 21, 2016 · abec786 · abec786
1 parent 0f8fa6b
commit abec786
Show file tree

Hide file tree

Showing 17 changed files with 187 additions and 0 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
@@ -17,6 +17,17 @@ package object FoBoAJSAPI {
 
   override def toString() = FoBoAJSAPI.API.toString()
 
+  /**
+   * Initiate FoBo's Angular API in you bootstrap liftweb Boot.
+   * 
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoAJSAPI => FoBo}
+   *    :
+   *   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
 
   object API extends API {

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
@@ -18,6 +18,17 @@ package object FoBoAJSRes {
 
   override def toString() = FoBoAJSRes.Resource.toString()
 
+  /**
+   * Initiate FoBo's Angular Resource(s) in you bootstrap liftweb Boot.
+   * 
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoAJSRes => FoBo}
+   *    :
+   *   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
 
   object Resource extends Resource {

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
@@ -18,6 +18,17 @@ package object FoBoTBAPI {
 
   override def toString() = FoBoTBAPI.API.toString()
 
+  /**
+   * Initiate FoBo's Bootstrap 3 API in you bootstrap liftweb Boot.
+   *
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoTBAPI => FoBo}
+   *    :
+   *   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
 
   object API extends API {

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
@@ -18,6 +18,17 @@ package object FoBoTBRes {
 
   override def toString() = FoBoTBRes.Resource.toString()
 
+  /**
+   * Initiate FoBo's Bootstrap 2 Resource(s) in you bootstrap liftweb Boot.
+   *
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoTBRes => FoBo}
+   *    :
+   *   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
 
   object Resource extends Resource {

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
@@ -18,6 +18,17 @@ package object FoBoBsAPI {
 
   override def toString() = FoBoBsAPI.API.toString()
 
+  /**
+   * Initiate FoBo's Bootstrap 3 API in you bootstrap liftweb Boot.
+   * 
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoBsAPI => FoBo}
+   *    :
+   *   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
 
   object API extends API {

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
@@ -19,6 +19,17 @@ package object FoBoBsRes {
 
   override def toString() = FoBoBsRes.Resource.toString()
 
+  /**
+   * Initiate FoBo's Bootstrap 3 Resource(s) in you bootstrap liftweb Boot.
+   * 
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoBsRes => FoBo}
+   *    :
+   *   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
 
   object Resource extends Resource {

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
@@ -17,6 +17,17 @@ package object FoBoAPI {
 
   //override def toString() = FoBoAPI.API.toString()
 
+  /**
+   * Initiate FoBo's FoBo API in you bootstrap liftweb Boot.
+   * 
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoAPI => FoBo}
+   *    :
+   *   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
 
   object API extends API {

diff --git a/Font-Awesome/Font-Awesome-API/src/main/scala/net/liftmodules/FoBoFA/FoBoFAAPI.scala b/Font-Awesome/Font-Awesome-API/src/main/scala/net/liftmodules/FoBoFA/FoBoFAAPI.scala
@@ -18,6 +18,17 @@ package object FoBoFAAPI {
 
   override def toString() = FoBoFAAPI.API.toString()
 
+  /**
+   * Initiate FoBo's Font Awesome API in you bootstrap liftweb Boot.
+   * 
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoFAAPI => FoBo}
+   *    :
+   *   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
 
   object API extends API {

diff --git a/Font-Awesome/Font-Awesome-Res/src/main/scala/net/liftmodules/FoBoFA/FoBoFARes.scala b/Font-Awesome/Font-Awesome-Res/src/main/scala/net/liftmodules/FoBoFA/FoBoFARes.scala
@@ -17,6 +17,17 @@ package object FoBoFARes {
 
   override def toString() = FoBoFARes.Resource.toString()
 
+  /**
+   * Initiate FoBo's Font Awesome Resource(s) in you bootstrap liftweb Boot.
+   * 
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoFARes => FoBo}
+   *    :
+   *   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
 
   object Resource extends Resource {

diff --git a/...Prettify/Google-Code-Prettify-API/src/main/scala/net/liftmodules/FoBoGCP/FoBoGCPAPI.scala b/...Prettify/Google-Code-Prettify-API/src/main/scala/net/liftmodules/FoBoGCP/FoBoGCPAPI.scala
@@ -18,6 +18,17 @@ package object FoBoGCPAPI {
 
   override def toString() = FoBoGCPAPI.API.toString()
 
+  /**
+   * Initiate FoBo's Google Code Prettify API in you bootstrap liftweb Boot.
+   * 
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoGCPAPI => FoBo}
+   *    :
+   *   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
 
   object API extends API {

diff --git a/...ttify/Google-Code-Prettify-Res/src/main/scala/net/liftmodules/FoBoGCPRes/FoBoGCPRes.scala b/...ttify/Google-Code-Prettify-Res/src/main/scala/net/liftmodules/FoBoGCPRes/FoBoGCPRes.scala
@@ -19,6 +19,17 @@ package object FoBoGCPRes {
 
   override def toString() = FoBoGCPRes.Resource.toString()
 
+  /**
+   * Initiate FoBo's Google Code Prettify Resource(s) in you bootstrap liftweb Boot.
+   * 
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoGCPRes => FoBo}
+   *    :
+   *   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
 
   object Resource extends Resource {

diff --git a/JQuery/JQuery-API/src/main/scala/net/liftmodules/FoBoJQ/FoBoJQAPI.scala b/JQuery/JQuery-API/src/main/scala/net/liftmodules/FoBoJQ/FoBoJQAPI.scala
@@ -18,6 +18,17 @@ package object FoBoJQAPI {
 
   override def toString() = FoBoJQAPI.API.toString()
 
+  /**
+   * Initiate FoBo's JQuery API in you bootstrap liftweb Boot.
+   * 
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoJQAPI => FoBo}
+   *    :
+   *   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
 
   object API extends API {

diff --git a/JQuery/JQuery-Res/src/main/scala/net/liftmodules/FoBoJQ/FoBoJQRes.scala b/JQuery/JQuery-Res/src/main/scala/net/liftmodules/FoBoJQ/FoBoJQRes.scala
@@ -17,6 +17,17 @@ package object FoBoJQRes {
 
   override def toString() = FoBoJQRes.Resource.toString()
 
+  /**
+   * Initiate FoBo's JQuery Resource(s) in you bootstrap liftweb Boot.
+   * 
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoJQRes => FoBo}
+   *    :
+   *   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
 
   object Resource extends Resource {

diff --git a/Kinetic/KineticJS-API/src/main/scala/net/liftmodules/FoBoKi/FoBoKiAPI.scala b/Kinetic/KineticJS-API/src/main/scala/net/liftmodules/FoBoKi/FoBoKiAPI.scala
@@ -18,6 +18,17 @@ package object FoBoKiAPI {
 
   override def toString() = FoBoKiAPI.API.toString()
 
+  /**
+   * Initiate FoBo's KineticJs API in you bootstrap liftweb Boot.
+   * 
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoKiAPI => FoBo}
+   *    :
+   *   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
 
   object API extends API {

diff --git a/Kinetic/KineticJS-Res/src/main/scala/net/liftmodules/FoBoKiRes/FoBoKiRes.scala b/Kinetic/KineticJS-Res/src/main/scala/net/liftmodules/FoBoKiRes/FoBoKiRes.scala
@@ -17,6 +17,17 @@ package object FoBoKiRes {
 
   override def toString() = FoBoKiRes.Resource.toString()
 
+  /**
+   * Initiate FoBo's KineticJs Resource(s) in you bootstrap liftweb Boot.
+   * 
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoKiRes => FoBo}
+   *    :
+   *   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
 
   object Resource extends Resource {

diff --git a/Pace/Pace-API/src/main/scala/net/liftmodules/FoBoPa/FoBoPaAPI.scala b/Pace/Pace-API/src/main/scala/net/liftmodules/FoBoPa/FoBoPaAPI.scala
@@ -18,6 +18,17 @@ package object FoBoPaAPI {
 
   override def toString() = FoBoPaAPI.API.toString()
 
+  /**
+   * Initiate FoBo's Pace API in you bootstrap liftweb Boot.
+   * 
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoPaAPI => FoBo}
+   *    :
+   *   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
 
   object API extends API {

diff --git a/Pace/Pace-Res/src/main/scala/net/liftmodules/FoBoPaRes/FoBoPaRes.scala b/Pace/Pace-Res/src/main/scala/net/liftmodules/FoBoPaRes/FoBoPaRes.scala
@@ -17,6 +17,17 @@ package object FoBoPaRes {
 
   override def toString() = FoBoPaRes.Resource.toString()
 
+  /**
+   * Initiate FoBo's Pace Resource(s) in you bootstrap liftweb Boot.
+   * 
+   *  '''Example:'''
+   * {{{
+   *   import net.liftmodules.{FoBoPaRes => FoBo}
+   *    :
+   *   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
 
   object Resource extends Resource {