Browse Source

Make some files pass checkdoc test

Nicolas Goaziou 13 years ago
parent
commit
065c5c3241
4 changed files with 25 additions and 21 deletions
  1. 10 6
      lisp/org-footnote.el
  2. 2 3
      lisp/org-indent.el
  3. 1 1
      lisp/org-inlinetask.el
  4. 12 11
      lisp/org-list.el

+ 10 - 6
lisp/org-footnote.el

@@ -415,8 +415,12 @@ and value definition."
 
 
 (defun org-footnote-unique-label (&optional current)
 (defun org-footnote-unique-label (&optional current)
   "Return a new unique footnote label.
   "Return a new unique footnote label.
+
 The function returns the first \"fn:N\" or \"N\" label that is
 The function returns the first \"fn:N\" or \"N\" label that is
-currently not used."
+currently not used.
+
+Optional argument CURRENT is the list of labels active in the
+buffer."
   (unless current (setq current (org-footnote-all-labels)))
   (unless current (setq current (org-footnote-all-labels)))
   (let ((fmt (if (eq org-footnote-auto-label 'plain) "%d" "fn:%d"))
   (let ((fmt (if (eq org-footnote-auto-label 'plain) "%d" "fn:%d"))
 	(cnt 1))
 	(cnt 1))
@@ -603,11 +607,11 @@ If Org is amidst an export process, EXPORT-PROPS will hold the
 export properties of the buffer.
 export properties of the buffer.
 
 
 When EXPORT-PROPS is non-nil, the default action is to insert
 When EXPORT-PROPS is non-nil, the default action is to insert
-normalized footnotes towards the end of the pre-processing buffer.
-Some exporters like docbook, odt, etc. expect that footnote
-definitions be available before any references to them.  Such
-exporters can let bind `org-footnote-insert-pos-for-preprocessor' to
-symbol 'point-min to achieve the desired behaviour.
+normalized footnotes towards the end of the pre-processing
+buffer.  Some exporters (docbook, odt...) expect footnote
+definitions to be available before any references to them.  Such
+exporters can let bind `org-footnote-insert-pos-for-preprocessor'
+to symbol `point-min' to achieve the desired behaviour.
 
 
 Additional note on `org-footnote-insert-pos-for-preprocessor':
 Additional note on `org-footnote-insert-pos-for-preprocessor':
 1. This variable has not effect when FOR-PREPROCESSOR is nil.
 1. This variable has not effect when FOR-PREPROCESSOR is nil.

+ 2 - 3
lisp/org-indent.el

@@ -54,8 +54,7 @@
 (defconst org-indent-max 40
 (defconst org-indent-max 40
   "Maximum indentation in characters.")
   "Maximum indentation in characters.")
 (defconst org-indent-max-levels 20
 (defconst org-indent-max-levels 20
-  "Maximum added level through virtual indentation, in
-characters.
+  "Maximum added level through virtual indentation, in characters.
 
 
 It is computed by multiplying `org-indent-indentation-per-level'
 It is computed by multiplying `org-indent-indentation-per-level'
 minus one by actual level of the headline minus one.")
 minus one by actual level of the headline minus one.")
@@ -88,7 +87,7 @@ This is used locally in each buffer being initialized.")
 (defvar org-hide-leading-stars-before-indent-mode nil
 (defvar org-hide-leading-stars-before-indent-mode nil
   "Used locally.")
   "Used locally.")
 (defvar org-indent-modified-headline-flag nil
 (defvar org-indent-modified-headline-flag nil
-  "Non nil if the last deletion acted on an headline.
+  "Non-nil means the last deletion operated on an headline.
 It is modified by `org-indent-notify-modified-headline'.")
 It is modified by `org-indent-notify-modified-headline'.")
 
 
 
 

+ 1 - 1
lisp/org-inlinetask.el

@@ -406,7 +406,7 @@ Either remove headline and meta data, or do special formatting."
 
 
 (defvar org-indent-indentation-per-level) ; defined in org-indent.el
 (defvar org-indent-indentation-per-level) ; defined in org-indent.el
 (defun org-inlinetask-fontify (limit)
 (defun org-inlinetask-fontify (limit)
-  "Fontify the inline tasks."
+  "Fontify the inline tasks down to LIMIT."
   (let* ((nstars (if org-odd-levels-only
   (let* ((nstars (if org-odd-levels-only
 		     (1- (* 2 (or org-inlinetask-min-level 200)))
 		     (1- (* 2 (or org-inlinetask-min-level 200)))
 		   (or org-inlinetask-min-level 200)))
 		   (or org-inlinetask-min-level 200)))

+ 12 - 11
lisp/org-list.el

@@ -269,7 +269,7 @@ By default, automatic actions are taken when using
  \\[org-meta-return], \\[org-metaright], \\[org-metaleft],
  \\[org-meta-return], \\[org-metaright], \\[org-metaleft],
  \\[org-shiftmetaright], \\[org-shiftmetaleft],
  \\[org-shiftmetaright], \\[org-shiftmetaleft],
  \\[org-ctrl-c-minus], \\[org-toggle-checkbox] or
  \\[org-ctrl-c-minus], \\[org-toggle-checkbox] or
- \\[org-insert-todo-heading]. You can disable individually these
+ \\[org-insert-todo-heading].  You can disable individually these
  rules by setting them to nil.  Valid rules are:
  rules by setting them to nil.  Valid rules are:
 
 
 bullet    when non-nil, cycling bullet do not allow lists at
 bullet    when non-nil, cycling bullet do not allow lists at
@@ -990,8 +990,8 @@ items, as returned by `org-list-prevs-alist'."
 
 
 (defun org-list-get-children (item struct parents)
 (defun org-list-get-children (item struct parents)
   "List all children of ITEM, or nil.
   "List all children of ITEM, or nil.
-STRUCT is the list structure. PARENTS is the alist of parents, as
-returned by `org-list-parents-alist'."
+STRUCT is the list structure.  PARENTS is the alist of parents,
+as returned by `org-list-parents-alist'."
   (let (all child)
   (let (all child)
     (while (setq child (car (rassq item parents)))
     (while (setq child (car (rassq item parents)))
       (setq parents (cdr (member (assq child parents) parents)))
       (setq parents (cdr (member (assq child parents) parents)))
@@ -1370,8 +1370,8 @@ If DEST is a buffer position, the function will assume it points
 to another item in the same list as ITEM, and will move the
 to another item in the same list as ITEM, and will move the
 latter just before the former.
 latter just before the former.
 
 
-If DEST is `begin' \(resp. `end'\), ITEM will be moved at the
-beginning \(resp. end\) of the list it belongs to.
+If DEST is `begin' \(respectively `end'\), ITEM will be moved at
+the beginning \(respectively end\) of the list it belongs to.
 
 
 If DEST is a string like \"N\", where N is an integer, ITEM will
 If DEST is a string like \"N\", where N is an integer, ITEM will
 be moved at the Nth position in the list.
 be moved at the Nth position in the list.
@@ -1554,7 +1554,7 @@ bullets between START and END."
 (defun org-list-use-alpha-bul-p (first struct prevs)
 (defun org-list-use-alpha-bul-p (first struct prevs)
   "Non-nil if list starting at FIRST can have alphabetical bullets.
   "Non-nil if list starting at FIRST can have alphabetical bullets.
 
 
-STRUCT is list structure. PREVS is the alist of previous items,
+STRUCT is list structure.  PREVS is the alist of previous items,
 as returned by `org-list-prevs-alist'."
 as returned by `org-list-prevs-alist'."
   (and org-alphabetical-lists
   (and org-alphabetical-lists
        (catch 'exit
        (catch 'exit
@@ -1753,7 +1753,7 @@ This function modifies STRUCT."
 	    (nth index all-items)))))))
 	    (nth index all-items)))))))
 
 
 (defun org-list-struct-apply-struct (struct old-struct)
 (defun org-list-struct-apply-struct (struct old-struct)
-  "Apply set-difference between STRUCT and OLD-STRUCT to the buffer.
+  "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
 
 
 OLD-STRUCT is the structure before any modifications, and STRUCT
 OLD-STRUCT is the structure before any modifications, and STRUCT
 the structure to be applied.  The function will only modify parts
 the structure to be applied.  The function will only modify parts
@@ -1814,7 +1814,7 @@ Initial position of cursor is restored after the changes."
 		 (replace-match "" nil nil nil 1))
 		 (replace-match "" nil nil nil 1))
 		(t (let ((counterp (match-end 2)))
 		(t (let ((counterp (match-end 2)))
 		     (goto-char (if counterp (1+ counterp) (match-end 1)))
 		     (goto-char (if counterp (1+ counterp) (match-end 1)))
-		   (insert (concat new-box (unless counterp " "))))))
+		     (insert (concat new-box (unless counterp " "))))))
 	       ;; c. Indent item to appropriate column.
 	       ;; c. Indent item to appropriate column.
 	       (unless (= new-ind old-ind)
 	       (unless (= new-ind old-ind)
 		 (delete-region (goto-char (point-at-bol))
 		 (delete-region (goto-char (point-at-bol))
@@ -1951,7 +1951,7 @@ beginning of the item."
 (defun org-list-set-item-visibility (item struct view)
 (defun org-list-set-item-visibility (item struct view)
   "Set visibility of ITEM in STRUCT to VIEW.
   "Set visibility of ITEM in STRUCT to VIEW.
 
 
-Possible values are: `folded', `children' or `subtree'. See
+Possible values are: `folded', `children' or `subtree'.  See
 `org-cycle' for more information."
 `org-cycle' for more information."
   (cond
   (cond
    ((eq view 'folded)
    ((eq view 'folded)
@@ -2495,7 +2495,8 @@ Otherwise it will be `org-todo'."
       'org-checkbox-statistics-todo)))
       'org-checkbox-statistics-todo)))
 
 
 (defun org-update-checkbox-count-maybe (&optional all)
 (defun org-update-checkbox-count-maybe (&optional all)
-  "Update checkbox statistics unless turned off by user."
+  "Update checkbox statistics unless turned off by user.
+With an optional argument ALL, update them in the whole buffer."
   (when (cdr (assq 'checkbox org-list-automatic-rules))
   (when (cdr (assq 'checkbox org-list-automatic-rules))
     (org-update-checkbox-count all))
     (org-update-checkbox-count all))
   (run-hooks 'org-checkbox-statistics-hook))
   (run-hooks 'org-checkbox-statistics-hook))
@@ -2715,7 +2716,7 @@ Capital letters will reverse the sort order.
 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
 a function to be called with point at the beginning of the
 a function to be called with point at the beginning of the
 record.  It must return either a string or a number that should
 record.  It must return either a string or a number that should
-serve as the sorting key for that record. It will then use
+serve as the sorting key for that record.  It will then use
 COMPARE-FUNC to compare entries."
 COMPARE-FUNC to compare entries."
   (interactive "P")
   (interactive "P")
   (let* ((case-func (if with-case 'identity 'downcase))
   (let* ((case-func (if with-case 'identity 'downcase))