[elpa] externals/lentic 2f9d3fbd7f 153/333: All files are now orgel documented.

[ELPA Syncer]

branch: externals/lentic
commit 2f9d3fbd7f3456e91634a8f362baa7bac40c00df
Author: Phillip Lord <phillip.lord@newcastle.ac.uk>
Commit: Phillip Lord <phillip.lord@newcastle.ac.uk>

    All files are now orgel documented.
    
    Lentic should probably use itself!
---
 lentic-asciidoc.el   |  6 ++++++
 lentic-block.el      |  9 ++++++++-
 lentic-delayed.el    | 20 ++++++++++++--------
 lentic-dev.el        | 38 ++++++++++++++++++++++++++++++++++++--
 lentic-latex-code.el | 18 ++++++++++++------
 lentic-org.el        |  2 ++
 6 files changed, 76 insertions(+), 17 deletions(-)

diff --git a/lentic-asciidoc.el b/lentic-asciidoc.el
index 0606d7331c..634febf95a 100644
--- a/lentic-asciidoc.el
+++ b/lentic-asciidoc.el
@@ -1,5 +1,7 @@
 ;;; lentic-asciidoc.el --- asciidoc support for lentic -*- lexical-binding: t 
-*-
 
+;;; Header:
+
 ;; This file is not part of Emacs
 
 ;; Author: Phillip Lord <phillip.lord@newcastle.ac.uk>
@@ -27,6 +29,8 @@
 ;; Lentic buffers with asciidoc [source] blocks.
 
 ;;; Code:
+
+;; #+begin_src emacs-lisp
 (require 'lentic-block)
 (require 'm-buffer)
 
@@ -154,3 +158,5 @@ This should remove other \"....\" matches.
 
 (provide 'lentic-asciidoc)
 ;;; lentic-asciidoc.el ends here
+
+;; #+end_src
diff --git a/lentic-block.el b/lentic-block.el
index 7c59e5c66f..12af641351 100644
--- a/lentic-block.el
+++ b/lentic-block.el
@@ -1,5 +1,7 @@
 ;;; lentic-block.el --- Comment blocks in one buffer -*- lexical-binding: t -*-
 
+;;; Header:
+
 ;; This file is not part of Emacs
 
 ;; Author: Phillip Lord <phillip.lord@newcastle.ac.uk>
@@ -27,11 +29,14 @@
 ;; Provides configuration for lentics where one buffer has beginning of
 ;; line comment characters that the other one lacks. Commented regions may be
 ;; in blocks with block-delimiters between then.
+
+;;; Code:
+
+;; #+begin_src emacs-lisp
 (require 'm-buffer)
 (require 'm-buffer-at)
 (require 'lentic)
 
-;;; Code:
 (defclass lentic-block-configuration (lentic-default-configuration)
   ((comment :initarg :comment
             :documentation "The comment character")
@@ -412,3 +417,5 @@ between the two buffers; we don't care which one has 
comments."
 (provide 'lentic-block)
 
 ;;; lentic-block.el ends here
+
+;; #+end_src
diff --git a/lentic-delayed.el b/lentic-delayed.el
index 04f3a6d066..569d1ef5c1 100644
--- a/lentic-delayed.el
+++ b/lentic-delayed.el
@@ -1,5 +1,7 @@
 ;; lentic-delayed.el --- lentics but slowly -*- lexical-binding: t -*-
 
+;;; Header:
+
 ;; This file is not part of Emacs
 
 ;; Author: Phillip Lord <phillip.lord@newcastle.ac.uk>
@@ -22,16 +24,16 @@
 ;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
-;;
-;; Currently, the implementation of things like lentic-block.el is
-;; quite slow. This is exacerbated by changes which percolate though large
-;; parts of the buffer. Of course, the obvious solution would be to fix the
-;; dodgy algorithms in lentic-block, but why do that when instead you
-;; can run the same dodgy algorithms on the idle cycle. This has the advantage
-;; that multiple changes with no idle setp in between will be aggregated.
 
+;; This runs lentic updates in the idle cycle. It is not really necessary now,
+;; as lentic now percolates updates incrementally, rather than copying entire
+;; buffers with every keypress.
+
+;; However, incremental updates are a lot harder to implement than cloning the
+;; entire buffer, so this might still be useful.
 
 ;;; Code:
+;; #+begin_src emacs-lisp
 (require 'lentic)
 (require 'dash)
 
@@ -93,7 +95,7 @@
   (lentic-delayed-ensure-timer))
 
 (defmethod lentic-delayed-clone ((conf
-                                         lentic-delayed-configuration))
+                                  lentic-delayed-configuration))
   ;; inhibit-modification-hooks or we percolate back to the start
   (let ((inhibit-modification-hooks t))
     (lentic-clone (oref conf :delayed))
@@ -106,3 +108,5 @@
           (lentic-delayed-configuration "delayed" :delayed lentic-config))))
 
 (provide 'lentic-delayed)
+;;; lentic-delayed.el ends here
+;; #+end_src
diff --git a/lentic-dev.el b/lentic-dev.el
index 02721b4e58..d180c3674c 100644
--- a/lentic-dev.el
+++ b/lentic-dev.el
@@ -1,3 +1,36 @@
+;; lentic-dev.el --- Tools for developers -*- lexical-binding: t -*-
+
+;;; Header:
+
+;; This file is not part of Emacs
+
+;; Author: Phillip Lord <phillip.lord@newcastle.ac.uk>
+;; Maintainer: Phillip Lord <phillip.lord@newcastle.ac.uk>
+;; The contents of this file are subject to the GPL License, Version 3.0.
+;;
+;; Copyright (C) 2014, Phillip Lord, Newcastle University
+;;
+;; This program is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; Developing support for new forms of lentic buffers is not trivial. This
+;; file provides some support functions for doing so.
+
+;;; Code:
+
+;; #+begin_src emacs-lisp
 (require 'lentic)
 
 (defvar lentic-dev-insert-face 'font-lock-keyword-face)
@@ -25,8 +58,8 @@
          'face
          lentic-dev-insert-face)))
 
-(defvar lentic-enable-insertion-marking nil)
-(defun lentic-enable-insertion-marking ()
+(defvar lentic-dev-enable-insertion-marking nil)
+(defun lentic-dev-enable-insertion-marking ()
   (interactive)
   (if lentic-enable-insertion-marking
       (progn
@@ -40,3 +73,4 @@
     (message "Insertion marking on")))
 
 (provide 'lentic-dev)
+;; #+end_src
diff --git a/lentic-latex-code.el b/lentic-latex-code.el
index 693f718e4e..047c6ea28e 100644
--- a/lentic-latex-code.el
+++ b/lentic-latex-code.el
@@ -1,4 +1,7 @@
 ;;; lentic-latex-code.el -- Latex literate programming -*- lexical-binding: t 
-*-
+
+;;; Header:
+
 ;; This file is not part of Emacs
 
 ;; Author: Phillip Lord <phillip.lord@newcastle.ac.uk>
@@ -6,34 +9,36 @@
 ;; Version: 0.1
 
 ;; The contents of this file are subject to the GPL License, Version 3.0.
-;;
+
 ;; Copyright (C) 2014, Phillip Lord, Newcastle University
-;;
+
 ;; This program is free software: you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
 ;; the Free Software Foundation, either version 3 of the License, or
 ;; (at your option) any later version.
-;;
+
 ;; This program is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ;; GNU General Public License for more details.
-;;
+
 ;; You should have received a copy of the GNU General Public License
 ;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
-;;
+
 ;; A `lentic-block-configuration' environment where one buffer is latex
 ;; and the other is some programming language, with code blocks marked up with
 ;; a \begin{code}\end{code} environment.
-;;
+
 ;; The code environment is not normally defined and has been picked for this
 ;; reason. It avoids defining multiple init functions for different macros;
 ;; instead the code blocks can be interpreted using what ever environment the
 ;; author wants, by defining the code environment first.
 
 ;;; Code:
+
+;; #+begin_src emacs-lisp
 (require 'lentic-block)
 
 (defun lentic-clojure-to-latex-new ()
@@ -85,3 +90,4 @@
 (provide 'lentic-latex-code)
 
 ;;; lentic-latex-code ends here
+;; #+end_src
diff --git a/lentic-org.el b/lentic-org.el
index a709d6f819..4c5b5e8b24 100644
--- a/lentic-org.el
+++ b/lentic-org.el
@@ -321,6 +321,7 @@
    :comment-stop "#\\\+BEGIN_SRC emacs-lisp"
    :comment-start "#\\\+END_SRC"))
 
+;;;###autoload
 (defun lentic-org-orgel-init ()
   (lentic-org-to-orgel-new))
 
@@ -383,6 +384,7 @@
    :comment-stop "#\\\+BEGIN_SRC emacs-lisp"
    :comment-start "#\\\+END_SRC"))
 
+;;;###autoload
 (defun lentic-orgel-org-init ()
   (lentic-orgel-to-org-new))