[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
- [elpa] master 555820b 247/271: Merge branch 'master' into develop, (continued)
- [elpa] master 555820b 247/271: Merge branch 'master' into develop, Jackson Ray Hamilton, 2015/02/05
- [elpa] master 43bb3c1 261/271: Remove unnecessary file from .elpaignore., Jackson Ray Hamilton, 2015/02/05
- [elpa] master 195fbe7 196/271: Improve assertion message., Jackson Ray Hamilton, 2015/02/05
- [elpa] master d82f357 199/271: Merge branch 'feature/name-nodes' into develop, Jackson Ray Hamilton, 2015/02/05
- [elpa] master 310aca4 228/271: Use `save-excursion' before fontifying., Jackson Ray Hamilton, 2015/02/05
- [elpa] master 5cc5224 249/271: Update sentence spacing., Jackson Ray Hamilton, 2015/02/05
- [elpa] master de8eacd 204/271: Update benchmarks in readme., Jackson Ray Hamilton, 2015/02/05
- [elpa] master f15c193 189/271: Escape., Jackson Ray Hamilton, 2015/02/05
- [elpa] master 31ee972 197/271: Improve property lookup test., Jackson Ray Hamilton, 2015/02/05
- [elpa] master 3d034f9 262/271: Merge branch 'develop', Jackson Ray Hamilton, 2015/02/05
- [elpa] master 6d24750 206/271: Update docs.,
Jackson Ray Hamilton <=
- [elpa] master 6059dca 179/271: Add Travis CI., Jackson Ray Hamilton, 2015/02/05
- [elpa] master f2ace00 224/271: Add faces dynamically. Stop looping around at the last level., Jackson Ray Hamilton, 2015/02/05
- [elpa] master d44b426 208/271: Merge branch 'master' into develop, Jackson Ray Hamilton, 2015/02/05
- [elpa] master 3cff176 210/271: Add failing key-value pair test., Jackson Ray Hamilton, 2015/02/05
- [elpa] master e09d9ad 227/271: Add tests for comments and strings., Jackson Ray Hamilton, 2015/02/05
- [elpa] master 21cc6c6 200/271: Save benchmark logs to an untracked directory., Jackson Ray Hamilton, 2015/02/05
- [elpa] master 30a24f9 265/271: Add 'packages/context-coloring/' from commit 'f2b5d796d4dffc71b10503a8ae119bfa3274978e', Jackson Ray Hamilton, 2015/02/05
- [elpa] master 03d111c 235/271: Cleanup., Jackson Ray Hamilton, 2015/02/05
- [elpa] master eba74ae 192/271: Improve assertion functions., Jackson Ray Hamilton, 2015/02/05
- [elpa] master 127b312 225/271: Remove rear-nonsticky., Jackson Ray Hamilton, 2015/02/05