Changeset 29181

Timestamp:

01/28/09 19:10:12 (4 years ago)

Author:

hayamiz

Message:

rewrote some documentation
added help-do-xref' to ww-advised-functions'
ver 0.1.1

Location:

lang/elisp/widen-window-mode/trunk

Files:

• ChangeLog (modified) (1 diff)
• widen-window.el (modified) (7 diffs)

lang/elisp/widen-window-mode/trunk/ChangeLog

@@ +1 @@
+2009-01-28  Yuto Hayamizu  <haya@killie>
+
+        * widen-window.el: Rewrote some documentation
+        (ww-advised-functions): added `help-do-xref'
+        ver 0.1.1
+
 2008-11-15  Yuto Hayamizu  <haya@killie>
 

lang/elisp/widen-window-mode/trunk/widen-window.el

@@ -5 +5 @@
 ;; Author: Yuto Hayamizu <y.hayamizu@gmail.com>
 ;; Keywords: convenience
-;; Version: 0.1.0
+;; Version: 0.1.1
 
 ;; This file is free software; you can redistribute it and/or modify
@@ -39 +39 @@
 ;; `ww-ratio' must be greater than 0.0 and less than 1.0 .
 
-;; If you want to avoid widen window mode in a certain
-;; major mode(say `foo-mode'), customize the variable `ww-nonwide-modes'.
-
-;; Because this is still early release, sometimes window widening
-;; might not work even if it should. If you find some functions to be
-;; advised, add them to `ww-advised-functions'.
+;; If you want to disable widen window mode in a certain
+;; major mode(say `foo-mode'), add `foo-mode' to the variable `ww-nonwide-modes'.
+
+;; If `ww-width' is non-nil, horizontal window widening is done.
+;; You can turn it off by setting `ww-width' nil.
+;; `ww-height' is the same as.
+
+;; Window widening function `widen-current-window' is called after the
+;; invocation of a function listed in `ww-advised-functions'.
+;; By adding functions to or removing from this variable, you can
+;; control the invocation of window widening.
 
 ;;; Code:
@@ -89 +94 @@
     delete-window
     add-change-log-entry-other-window
+    help-do-xref
     )
   "Functions to be advised. Window widening function `widen-current-window' is fired after advised function was called."
@@ -95 +101 @@
 
 (defun widen-current-window ()
+  "The very function which resizes the current window."
+
   (interactive)
 
@@ -108 +116 @@
         ;; by calling ww-subtree only once.
         ;; So ww-subtree is called repeatedly until
-        ;; you can get what you want.
+        ;; www-subtree makes no change.
         (let ((sizeinfo-history nil)
               (last-sizeinfo nil)
@@ -127 +135 @@
 
 (defun ww-bw-wid (window-or-tree)
+  "Returns the width of WINDOW-OR-TREE"
   (- (bw-r window-or-tree) (bw-l window-or-tree)))
 
 (defun ww-bw-hei (window-or-tree)
+  "Returns the height of WINDOW-OR-TREE"
   (- (bw-b window-or-tree) (bw-t window-or-tree)))
 
@@ -249 +259 @@
 
 (defun widen-window-mode-maybe ()
-  "Return t if `widen-current-window' can run on current buffer."
+  "Return t and enable widen-window-mode if `widen-current-window' can called on current buffer."
   (if (and (not (minibufferp (current-buffer)))
            (not (memq major-mode ww-nonwide-modes)))