Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Verbiage and uniformity tweaks to JSArtifacts API docs.

  • Loading branch information...
commit 915dcba6a5d6f7b9e4b9312d13cbdc1f3d214a9a 1 parent 61ec6bd
@Shadowfiend Shadowfiend authored
Showing with 12 additions and 12 deletions.
  1. +12 −12 web/webkit/src/main/scala/net/liftweb/http/js/JSArtifacts.scala
View
24 web/webkit/src/main/scala/net/liftweb/http/js/JSArtifacts.scala
@@ -28,7 +28,7 @@ import net.liftweb.util.Helpers._
trait JSArtifacts {
/**
- * Toggles between current JS object and the object denominated by id
+ * Toggles the visibility of the element denomiated by id
*/
def toggle(id: String): JsExp
@@ -38,40 +38,40 @@ trait JSArtifacts {
def hide(id: String): JsExp
/**
- * Shows the element denominated by this id
+ * Shows the element denominated by id
*/
def show(id: String): JsExp
/**
- * Shows the element denoinated by id and puts the focus on it
+ * Shows the element denominated by id and puts the focus on it
*/
def showAndFocus(id: String): JsExp
/**
- * Serializes a form denominated by the id. It returns a query string
+ * Serializes a form denominated by id. It returns a query string
* containing the fields that are to be submitted
*/
def serialize(id: String): JsExp
/**
- * Replaces the content of the node with the provided id with the markup given by content
+ * Replaces the content of the node denominated by id with the markup given by content
*/
def replace(id: String, content: NodeSeq): JsCmd
/**
- * Sets the inner HTML of the element denominated by the id
+ * Sets the inner HTML of the element denominated by id
*/
def setHtml(id: String, content: NodeSeq): JsCmd
/**
- * Sets the JavScript that will be executed when document is ready
- * for processing
+ * Queues the JavaScript in cmd for execution when the document is
+ * ready for processing
*/
def onLoad(cmd: JsCmd): JsCmd
/**
- * Fades out the element having the provided id, by waiting
- * for the given duration and fades out during fadeTime
+ * Fades out the element denominated by id, by waiting
+ * for duration milliseconds and fading out for fadeTime milliseconds
*/
def fadeOut(id: String, duration: TimeSpan, fadeTime: TimeSpan): JsCmd
@@ -88,7 +88,7 @@ trait JSArtifacts {
def comet(data: AjaxInfo): String
/**
- * Trabsforms a JSON object intoits string representation
+ * Transforms a JSON object into its string representation
*/
def jsonStringify(in: JsExp): JsExp
@@ -146,7 +146,7 @@ object AjaxInfo {
}
/**
- * Represents the meta data of an AJax request.
+ * Represents the meta data of an Ajax request.
*/
case class AjaxInfo(data: JsExp, action: String, timeout: Long,
cache: Boolean, dataType: String,
Please sign in to comment.
Something went wrong with that request. Please try again.