From 49bbf34f9d5dffb12db9089da7eeb551efa0191e Mon Sep 17 00:00:00 2001 From: John Connors Date: Tue, 8 Apr 2008 14:16:40 +0100 Subject: [PATCH] Added better comments. --- ectags.el | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 53 insertions(+), 5 deletions(-) diff --git a/ectags.el b/ectags.el index 6b18c06..0db15e1 100644 --- a/ectags.el +++ b/ectags.el @@ -1,7 +1,53 @@ -; This buffer is for notes you don't want to save, and for Lisp evaluation. -;; If you want to create a file, visit that file with C-x C-f, -;; then enter the text in that file's own buffer. - +;;; ectags-select.el --- Select from multiple tags + +;; Copyright (C) 2007 Scott Frazer and (C) 2008 John Connors + +;; Author: John Connors +;; Author: Scott Frazer +;; Maintainer: John Connors +;; +;; Keywords: exuberant-ctags ectags tag select + +;; This file 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 2, or (at your option) +;; any later version. + +;; This file 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 GNU Emacs; see the file COPYING. If not, write to +;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +;; Boston, MA 02110-1301, USA. + +;;; Commentary: + + +;; Reworking of etags-select to work with exuberant-ctags and eldoc. +;; ectags-tag-directory will generate a tag file in the current directory +;; with the specified language using exuberant-ctags extended tag format +;; which contains useful information about the current tag such as +;; the signature, it's parent class, which class it is a member of. Eldoc +;; displays this information. At present it does not do a very good job +;; of finding the best candidate tag in an OO language where there may +;; be multiple tags with the same name. It tries, however. The tag file +;; needs to be in a specific format, hence the ectags-tag-directory-command. +;; ectags-visit-tags-table is used to load in a tag table. + +;; Open a buffer with file/lines of exact-match tags shown. Select one by +;; going to a line and pressing return. pop-tag-mark still works with this +;; code. +;; +;; +;; An up to date version of this code lives on repo.or.cz +;; at git://repo.or.cz/ectags.git + +;;; Code: + +; ;; TO DO : tag completion DONE ;; TO DO : tags search DONE ;; TO DO : eldoc integration DONE @@ -11,8 +57,10 @@ ;; TO DO : .. use abbreviated info ;; TO DO : .. use gzipped tag files ;; TO DO : use search for locating tag rather than line # -;; TO DO : some kind of higlighting for select buffer +;; TO DO : some kind of higlighting for select buffer WHY DOESN'T IT WORK!? ;; TO DO : include line matched when searching for references +;; TO DO : investigate CEDET to see if it can guide eldoc to a better +;; match for the tag under the cursor (require 'cl) (require 'custom) -- 2.11.4.GIT