Permalink
Browse files

Doc/comments fixups.

  • Loading branch information...
1 parent 0ba5bd1 commit 883208713a36a4deae90df7c4c6fd76e296228ff @jdtsmith committed May 13, 2013
Showing with 24 additions and 32 deletions.
  1. +2 −3 idlw-complete-structtag.el
  2. +2 −4 idlw-help.el
  3. +20 −25 idlwave.el
@@ -73,7 +73,8 @@
;; and offers the tags for completion.
;;
;; In the idlwave shell, idlwave sends a "print,tag_names()" for the
-;; variable to idl and determines the current tag list dynamically.
+;; variable to idl and determines the current tag list dynamically for
+;; completion.
;;
;; Notes
;; -----
@@ -243,5 +244,3 @@ an up-to-date completion list."
(provide 'idlw-complete-structtag)
;;; idlw-complete-structtag.el ends here
-
-
View
@@ -1,7 +1,7 @@
;;; idlw-help.el --- HTML Help code for IDLWAVE
;; Copyright (c) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
-;; 2009, 2010 Free Software Foundation, Inc.
+;; 2009, 2010, 2012, 2013 Free Software Foundation, Inc.
;;
;; Authors: J.D. Smith <jdtsmith _AT_ gmail.com>
;; Carsten Dominik <dominik _AT_ science.uva.nl>
@@ -681,7 +681,6 @@ Those words in `idlwave-completion-help-links' have links. The
(select-window (previous-window)))
(t (kill-buffer (idlwave-help-get-help-buffer)))))
-
(defvar default-toolbar-visible-p)
(defun idlwave-help-display-help-window (&optional pos-or-func)
@@ -778,7 +777,6 @@ see if a link is set for it. Try extra help functions if necessary."
(idlwave-help-error name type class keyword))
(select-window cw)))
-
(defun idlwave-help-html-link (link)
"Get html help on a given LINK."
(let ((browse-url-browser-function idlwave-help-browser-function)
@@ -915,7 +913,6 @@ This function can be used as `idlwave-extra-help-function'."
(point)))
-
(defun idlwave-help-find-routine-definition (name type class keyword)
"Find the definition of routine CLASS::NAME in current buffer.
KEYWORD is ignored. Returns the point of match if successful, nil otherwise."
@@ -1205,6 +1202,7 @@ Useful when source code is displayed as help. See the option
(defvar idlwave-help-with-topic-history nil
"The history of help topics selected with the minibuffer.")
+;; XXX
(defun idlwave-help-with-topic (&optional topic)
"Prompt for and provide help with TOPIC."
(interactive)
View
@@ -1,7 +1,7 @@
;; idlwave.el --- IDL editing mode for GNU Emacs
;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
-;; 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
+;; 2008, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
;; Authors: J.D. Smith <jdsmith _AT_ alum.mit.edu>
;; Carsten Dominik <dominik _AT_ science.uva.nl>
@@ -28,20 +28,12 @@
;;; Commentary:
;; IDLWAVE enables feature-rich development and interaction with IDL,
-;; the Interactive Data Language, produced by Research Systems, Inc.
-;; It provides a compelling, full-featured alternative to the IDLDE
-;; development environment bundled with IDL.
+;; the Interactive Data Language. It provides a compelling,
+;; full-featured alternative to the IDLDE development environment
+;; bundled with IDL.
-;; In the remotely distant past, based on pascal.el, though bears
-;; little resemblance to it now.
-;;
-;; Incorporates many ideas, such as abbrevs, action routines, and
-;; continuation line indenting, from wave.el.
-;; wave.el original written by Lubos Pochman, Precision Visuals, Boulder.
-;;
-;; See the mode description ("C-h m" in idlwave-mode or "C-h f idlwave-mode")
-;; for features, key bindings, and info.
-;; Also, Info format documentation is available with `M-x idlwave-info'
+;; See the mode description ("C-h m" in idlwave-mode or "C-h f
+;; idlwave-mode") for features, key bindings, and info.
;;
;; New versions of IDLWAVE, documentation, and more information
;; available from:
@@ -62,23 +54,31 @@
;; SOURCE
;; ======
;;
-;; The newest version of this file is available from the maintainer's
+;; The newest version of IDLWAVE is available from the maintainer's
;; Webpage:
;;
-;; http://idlwave.org
+;; http://github.com/jdtsmith/idlwave
;;
;; DOCUMENTATION
;; =============
;;
-;; IDLWAVE is documented online in info format. A printable version
-;; of the documentation is available from the maintainers webpage (see
-;; SOURCE).
+;; Info format documentation is available, also accessible with `M-x
+;; idlwave-info'. IDLWAVE is documented online in info format. A
+;; printable version of the documentation is available from the
+;; maintainers webpage (see SOURCE).
;;
;;
;; ACKNOWLEDGMENTS
;; ===============
;;
-;; Thanks to the following people for their contributions and comments:
+;; In the remotely distant past, based on pascal.el.
+;;
+;; Incorporates many ideas, such as abbrevs, action routines, and
+;; continuation line indenting, from wave.el, originally written by
+;; Lubos Pochman, Precision Visuals, Boulder.
+;;
+;; Thanks to the following people for their contributions and
+;; comments:
;;
;; Ulrik Dickow <dickow_at_nbi.dk>
;; Eric E. Dors <edors_at_lanl.gov>
@@ -136,11 +136,6 @@
;; limited to comments only and occurs only when a comment
;; paragraph is filled via `idlwave-fill-paragraph'.
;;
-;; Muti-statement lines (using "&") on block begin and end lines can
-;; ruin the formatting. For example, multiple end statements on a
-;; line: endif & endif. Using "&" outside of block begin/end lines
-;; should be okay.
-;;
;; Determining the expression at point for printing and other
;; examination commands is somewhat rough: currently only fairly
;; simple entities are found. You can always drag-select or examine

0 comments on commit 8832087

Please sign in to comment.