emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] master 6d24750 206/271: Update docs.


From: Jackson Ray Hamilton
Subject: [elpa] master 6d24750 206/271: Update docs.
Date: Thu, 05 Feb 2015 18:31:14 +0000

branch: master
commit 6d24750d60d78d536b59c46a022d286e604138c5
Author: Jackson Ray Hamilton <address@hidden>
Commit: Jackson Ray Hamilton <address@hidden>

    Update docs.
---
 context-coloring.el |   16 ++++++++++++----
 1 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/context-coloring.el b/context-coloring.el
index 56e3e28..00b4cfb 100644
--- a/context-coloring.el
+++ b/context-coloring.el
@@ -336,7 +336,9 @@ buffer."
 (defun context-coloring-scopify-shell-command (command &optional callback)
   "Invokes a scopifier with the current buffer's contents,
 reading the scopifier's response asynchronously and applying a
-parsed list of tokens to `context-coloring-apply-tokens'."
+parsed list of tokens to `context-coloring-apply-tokens'.
+
+Invokes CALLBACK when complete."
 
   ;; Prior running tokenization is implicitly obsolete if this function is
   ;; called.
@@ -390,12 +392,16 @@ parsed list of tokens to `context-coloring-apply-tokens'."
   `(js-mode ,context-coloring-javascript-scopifier
             js2-mode ,context-coloring-js2-colorizer
             js3-mode ,context-coloring-javascript-scopifier)
-  "Property list mapping major modes to scopification programs."
+  "Property list mapping major modes to scopification and
+colorization programs."
   :group 'context-coloring)
 
 (defun context-coloring-dispatch (&optional callback)
   "Determines the optimal track for scopification / colorization
-of the current buffer, then does it."
+of the current buffer, then executes it.
+
+Invokes CALLBACK when complete. It is invoked synchronously for
+elisp tracks, and asynchronously for shell command tracks."
   (let ((dispatch (plist-get context-coloring-dispatch-plist major-mode)))
     (if (null dispatch)
         (message "%s" "Context coloring is not available for this major mode"))
@@ -427,7 +433,9 @@ of the current buffer, then does it."
 ;;; Colorization
 
 (defun context-coloring-colorize (&optional callback)
-  "Colors the current buffer by function context."
+  "Colors the current buffer by function context.
+
+Invokes CALLBACK when complete; see `context-coloring-dispatch'."
   (interactive)
   (let ((start-time (float-time)))
     (context-coloring-dispatch



reply via email to

[Prev in Thread] Current Thread [Next in Thread]