branch: elpa/flx
commit 451711cfeb23e0ebd56c3fe775ff3df6401bbd50
Author: Bozhidar Batsov <bozhi...@tradeo.com>
Commit: Bozhidar Batsov <bozhi...@tradeo.com>
Improve comment headers
I've adjusted the comment headers (and footers) to be aligned with the
commonly accepted standard format and `M-x checkdoc`.
---
flx-ido.el | 64 +++++++++++++++++++++++-------------------------------------
flx.el | 66 +++++++++++++++++++-------------------------------------------
2 files changed, 44 insertions(+), 86 deletions(-)
diff --git a/flx-ido.el b/flx-ido.el
index 5a61a12abc..a21352d267 100644
--- a/flx-ido.el
+++ b/flx-ido.el
@@ -1,45 +1,18 @@
;;; flx-ido.el --- flx integration for ido
-;; this file is not part of Emacs
+;; Copyright © 2013 Le Wang
-;; Copyright (C) 2013 Le Wang
;; Author: Le Wang
;; Maintainer: Le Wang
;; Description: flx integration for ido
-;; Author: Le Wang
-;; Maintainer: Le Wang
-
;; Created: Sun Apr 21 20:38:36 2013 (+0800)
;; Version: 0.2
-;; Last-Updated:
-;; By:
-;; Update #: 60
-;; URL:
-;; Keywords:
-;; Compatibility:
+;; URL: https://github.com/lewang/flx
-;;; Installation:
+;; This file is NOT part of GNU Emacs.
-;; Add to your init file:
-;;
-;; (require 'flx-ido)
-;; (ido-mode 1)
-;; (ido-everywhere 1)
-;; (flx-ido-mode 1)
-;; ;; disable ido faces to see flx highlights.
-;; (setq ido-use-faces nil)
-;;
-;;
-;;
-
-;;; Commentary:
-
-;;
-;;
-;;
+;;; License
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;;
;; 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, or
@@ -54,13 +27,28 @@
;; along with this program; see the file COPYING. If not, write to
;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth
;; Floor, Boston, MA 02110-1301, USA.
-;;
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;;;
-;;; credit to Scott Frazer's blog entry
here:http://scottfrazersblog.blogspot.com.au/2009/12/emacs-better-ido-flex-matching.html
-;;;
+;;; Commentary:
+
+;; This package provides a more powerful alternative to `ido-mode''s
+;; built-in flex matching.
+;;; Acknowledgments
+
+;; Scott Frazer's blog entry
http://scottfrazersblog.blogspot.com.au/2009/12/emacs-better-ido-flex-matching.html
+;; provided a lot of inspiration.
+;; ido-hacks was helpful for ido optimization
+
+;;; Installation:
+
+;; Add the following code to your init file:
+;;
+;; (require 'flx-ido)
+;; (ido-mode 1)
+;; (ido-everywhere 1)
+;; (flx-ido-mode 1)
+;; ;; disable ido faces to see flx highlights.
+;; (setq ido-use-faces nil)
;;; Code:
@@ -211,8 +199,4 @@ item, in which case, the ending items are deleted."
(provide 'flx-ido)
-
-
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; flx-ido.el ends here
-
diff --git a/flx.el b/flx.el
index e2aad55c34..6cfef3b1fa 100644
--- a/flx.el
+++ b/flx.el
@@ -1,37 +1,18 @@
;;; flx.el --- fuzzy matching with good sorting
-;; this file is not part of Emacs
+;; Copyright © 2013 Le Wang
-;; Copyright (C) 2013 Le Wang
;; Author: Le Wang
;; Maintainer: Le Wang
;; Description: fuzzy matching with good sorting
-;; Author: Le Wang
-;; Maintainer: Le Wang
-
;; Created: Wed Apr 17 01:01:41 2013 (+0800)
;; Version: 0.1
-;; Last-Updated:
-;; By:
-;; Update #: 17
-;; URL:
-;; Keywords:
-;; Compatibility:
-
-;;; Installation:
-
-;;
-;;
-;;
+;; URL: https://github.com/lewang/flx
-;;; Commentary:
+;; This file is NOT part of GNU Emacs.
-;;
-;;
-;;
+;;; License
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;;
;; 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, or
@@ -46,26 +27,27 @@
;; along with this program; see the file COPYING. If not, write to
;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth
;; Floor, Boston, MA 02110-1301, USA.
-;;
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-
-;;; Code:
+;;; Commentary:
+;; Implementation notes
+;; --------------------
+;;
+;; Use defsubst instead of defun
+;;
+;; * Using bitmaps to check for matches worked out to be SLOWER than just
+;; scanning the string and using `flx-get-matches'.
+;;
+;; * Consing causes GC, which can often slowdown Emacs more than the benefits
+;; of an optimization.
-;;; credit to scott frazer's blog entry
here:http://scottfrazersblog.blogspot.com.au/2009/12/emacs-better-ido-flex-matching.html
-;;; credit to ido-hacks for ido optimization
+;;; Acknowledgments
-;;; Use defsubst instead of defun
+;; Scott Frazer's blog entry
http://scottfrazersblog.blogspot.com.au/2009/12/emacs-better-ido-flex-matching.html
+;; provided a lot of inspiration.
+;; ido-hacks was helpful for ido optimization
-;;; Notes:
-;;;
-;;; * Using bitmaps to check for matches worked out to be SLOWER than just
-;;; scanning the string and using `flx-get-matches'.
-;;;
-;;; * Consing causes GC, which can often slowdown Emacs more than the benefits
-;;; of an optimization.
-;;;
+;;; Code:
(eval-when-compile (require 'cl))
@@ -358,12 +340,4 @@ SCORE of nil means to clear the properties."
(provide 'flx)
-
-
-
-
-
-
-
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; flx.el ends here
