Server IP : 111.118.215.189 / Your IP : 13.59.31.221 Web Server : Apache System : Linux md-in-83.webhostbox.net 4.19.286-203.ELK.el7.x86_64 #1 SMP Wed Jun 14 04:33:55 CDT 2023 x86_64 User : a1673wkz ( 2475) PHP Version : 8.2.25 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON Directory (0755) : /usr/share/emacs/24.3/lisp/emacs-lisp/ |
[ Home ] | [ C0mmand ] | [ Upload File ] |
---|
;ELC ;;; Compiled by mockbuild@buildfarm06-new.corp.cloudlinux.com on Fri Oct 11 10:08:59 2024 ;;; from file /builddir/build/BUILD/emacs-24.3/lisp/emacs-lisp/checkdoc.el ;;; in Emacs version 24.3.1 ;;; with all optimizations. ;;; This file uses dynamic docstrings, first added in Emacs 19.29. ;;; This file does not contain utf-8 non-ASCII characters, ;;; and so can be loaded in Emacs versions earlier than 23. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; #@56 Release version of checkdoc you are currently running. (defvar checkdoc-version "0.6.1" (#$ . 562)) (byte-code "\300\301!\210\300\302!\210\303\304\305\306\307\310\311\312\313\314& \210\315\316\317\320\321\322\311\304\313\323& \210\315\324\325\326\311\304\321\327&\210\315\330\331\332\311\304\321\333&\210\315\334\331\335\311\304\321\333&\210\315\336\305\337\311\304\321\333&\210\315\340\305\341\311\304\321\333&\210\315\342\305\343\311\304\321\344&\207" [require help-mode thingatpt custom-declare-group checkdoc nil "Support for doc string checking in Emacs Lisp." :prefix "checkdoc" :group lisp :version "20.3" custom-declare-variable checkdoc-minor-mode-string " CDoc" "String to display in mode line when Checkdoc mode is enabled; nil for none." :type (choice string (const :tag "None" nil)) "23.1" checkdoc-autofix-flag 'semiautomatic "Non-nil means attempt auto-fixing of doc strings.\nIf this value is the symbol `query', then the user is queried before\nany change is made. If the value is `automatic', then all changes are\nmade without asking unless the change is very-complex. If the value\nis `semiautomatic' or any other value, then simple fixes are made\nwithout asking, and complex changes are made by asking the user first.\nThe value `never' is the same as nil, never ask or change anything." (choice (const automatic) (const query) (const never) (other :tag "semiautomatic" semiautomatic)) checkdoc-bouncy-flag t "Non-nil means to \"bounce\" to auto-fix locations.\nSetting this to nil will silently make fixes that require no user\ninteraction. See `checkdoc-autofix-flag' for auto-fixing details." boolean checkdoc-force-docstrings-flag "Non-nil means that all checkable definitions should have documentation.\nStyle guide dictates that interactive functions MUST have documentation,\nand that it's good but not required practice to make non user visible items\nhave doc strings." checkdoc-force-history-flag "Non-nil means that files should have a History section or ChangeLog file.\nThis helps document the evolution of, and recent changes to, the package." checkdoc-permit-comma-termination-flag "Non-nil means the first line of a docstring may end with a comma.\nOrdinarily, a full sentence is required. This may be misleading when\nthere is a substantial caveat to the one-line description -- the comma\nshould be used when the first part could stand alone as a sentence, but\nit indicates that a modifying clause follows." checkdoc-spellcheck-documentation-flag "Non-nil means run Ispell on text based on value.\nThis is automatically set to nil if Ispell does not exist on your\nsystem. Possible values are:\n\n nil - Don't spell-check during basic style checks.\n defun - Spell-check when style checking a single defun\n buffer - Spell-check when style checking the whole buffer\n interactive - Spell-check during any interactive check.\n t - Always spell-check" (choice (const nil) (const defun) (const buffer) (const interactive) (const t))] 10) #@72 List of words that are correct when spell-checking Lisp documentation. (defvar checkdoc-ispell-lisp-words '("alist" "emacs" "etags" "keymap" "paren" "regexp" "sexp" "xemacs") (#$ . 3589)) (byte-code "\302\303\304\305\306\307\310\311&\210\302\312\313\314\306\307\310\315&\210\316\317\320\321#\210\322\321\211\203B @\317N\203; \320N\204; \323\320\317N#\210 A\211\204$ *\324\317\320\325#\207" [prop --dolist-tail-- custom-declare-variable checkdoc-max-keyref-before-warn 10 "The number of \\ [command-to-keystroke] tokens allowed in a doc string.\nAny more than this and a warning is generated suggesting that the construct\n\\ {keymap} be used instead." :group checkdoc :type integer checkdoc-arguments-in-order-flag t "Non-nil means warn if arguments appear out of order.\nSetting this to nil will mean only checking that all the arguments\nappear in the proper form in the documentation, not that they are in\nthe same order as they appear in the argument list. No mention is\nmade in the style guide relating to order." boolean defvaralias checkdoc-style-hooks checkdoc-style-functions nil (saved-value saved-variable-comment) put make-obsolete-variable "24.3"] 9) #@358 Hook run after the standard style check is completed. All functions must return nil or a string representing the error found. Useful for adding new user implemented commands. Each hook is called with two parameters, (DEFUNINFO ENDPOINT). DEFUNINFO is the return value of `checkdoc-defun-info'. ENDPOINT is the location of end of the documentation string. (defvar checkdoc-style-functions nil (#$ . 4774)) (byte-code "\302\303\304\305#\210\306\305\211\203, @\303N\203% \304N\204% \307\304\303N#\210 A\211\204 *\310\303\304\311#\207" [prop --dolist-tail-- defvaralias checkdoc-comment-style-hooks checkdoc-comment-style-functions nil (saved-value saved-variable-comment) put make-obsolete-variable "24.3"] 6) #@196 Hook run after the standard comment style check is completed. Must return nil if no errors are found, or a string describing the problem discovered. This is useful for adding additional checks. (defvar checkdoc-comment-style-functions nil (#$ . 5500)) #@33 Name of warning message buffer. (defvar checkdoc-diagnostic-buffer "*Style Warnings*" (#$ . 5759)) #@105 Regular expression used to identify a defun. A search leaves the cursor in front of the parameter list. (defvar checkdoc-defun-regexp "^(def\\(un\\|var\\|custom\\|macro\\|const\\|subst\\|advice\\)\\s-+\\(\\(\\sw\\|\\s_\\)+\\)[ \n]+" (#$ . 5865)) #@206 Non-nil means to attempt to check the voice of the doc string. This check keys off some words which are commonly misused. See the variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own. (custom-declare-variable 'checkdoc-verb-check-experimental-flag t '(#$ . 6119) :group 'checkdoc :type 'boolean) #@157 Non-nil means generate warnings in a buffer for browsing. Do not set this by hand, use a function like `checkdoc-current-buffer' with a universal argument. (defvar checkdoc-generate-compile-warnings-flag nil (#$ . 6443)) #@196 A list of symbol names (strings) which also happen to make good words. These words are ignored when unquoted symbols are searched for. This should be set in an Emacs Lisp file's local variables. (custom-declare-variable 'checkdoc-symbol-words nil '(#$ . 6671) :group 'checkdoc :type '(repeat (symbol :tag "Word"))) (defalias 'checkdoc-list-of-strings-p #[(obj) "<\205\f \301\302\303\">?\207" [obj nil mapcar stringp] 4]) #@62 List of words (not capitalized) which should be capitalized. (defvar checkdoc-proper-noun-list '("ispell" "xemacs" "emacs" "lisp") (#$ . 7100)) #@64 Regular expression derived from `checkdoc-proper-noun-regexp'. (defvar checkdoc-proper-noun-regexp (byte-code "\301\302\303\"\304Q\207" [checkdoc-proper-noun-list "\\_<" regexp-opt t "\\(\\_>\\|[.!?][ \n\"]\\)"] 4) (#$ . 7250)) #@65 Regular expression derived from `checkdoc-common-verbs-regexp'. (defvar checkdoc-common-verbs-regexp nil (#$ . 7486)) #@296 Alist of common words in the wrong voice and what should be used instead. Set `checkdoc-verb-check-experimental-flag' to nil to avoid this costly and experimental check. Do not modify this list without setting the value of `checkdoc-common-verbs-regexp' to nil which cause it to be re-created. (defvar checkdoc-common-verbs-wrong-voice '(("adds" . "add") ("allows" . "allow") ("appends" . "append") ("applies" . "apply") ("arranges" . "arrange") ("brings" . "bring") ("calls" . "call") ("catches" . "catch") ("changes" . "change") ("checks" . "check") ("contains" . "contain") ("converts" . "convert") ("creates" . "create") ("destroys" . "destroy") ("disables" . "disable") ("executes" . "execute") ("evals" . "evaluate") ("evaluates" . "evaluate") ("finds" . "find") ("forces" . "force") ("gathers" . "gather") ("generates" . "generate") ("goes" . "go") ("guesses" . "guess") ("highlights" . "highlight") ("holds" . "hold") ("ignores" . "ignore") ("indents" . "indent") ("initializes" . "initialize") ("inserts" . "insert") ("installs" . "install") ("investigates" . "investigate") ("keeps" . "keep") ("kills" . "kill") ("leaves" . "leave") ("lets" . "let") ("loads" . "load") ("looks" . "look") ("makes" . "make") ("marks" . "mark") ("matches" . "match") ("moves" . "move") ("notifies" . "notify") ("offers" . "offer") ("parses" . "parse") ("performs" . "perform") ("prepares" . "prepare") ("prepends" . "prepend") ("reads" . "read") ("raises" . "raise") ("removes" . "remove") ("replaces" . "replace") ("resets" . "reset") ("restores" . "restore") ("returns" . "return") ("runs" . "run") ("saves" . "save") ("says" . "say") ("searches" . "search") ("selects" . "select") ("sets" . "set") ("sex" . "s*x") ("shows" . "show") ("signifies" . "signify") ("sorts" . "sort") ("starts" . "start") ("stores" . "store") ("switches" . "switch") ("tells" . "tell") ("tests" . "test") ("toggles" . "toggle") ("tries" . "try") ("turns" . "turn") ("undoes" . "undo") ("unloads" . "unload") ("unmarks" . "unmark") ("updates" . "update") ("uses" . "use") ("yanks" . "yank")) (#$ . 7611)) #@52 Syntax table used by checkdoc in document strings. (defvar checkdoc-syntax-table (byte-code "\302!\303\304\305 #\210 )\207" [emacs-lisp-mode-syntax-table st make-syntax-table modify-syntax-entry 45 "w"] 4) (#$ . 9693)) (byte-code "\300\301\302\"\210\300\303\304\"\210\300\305\306\"\210\300\307\310\"\210\300\311\312\"\210\300\313\314\"\210\300\315\316\"\207" [defalias checkdoc-make-overlay make-overlay checkdoc-overlay-put overlay-put checkdoc-delete-overlay delete-overlay checkdoc-overlay-start overlay-start checkdoc-overlay-end overlay-end checkdoc-mode-line-update force-mode-line-update checkdoc-char= =] 3) #@173 Interactively check the entire buffer for style errors. The current status of the check will be displayed in a buffer which the users will view as each check is completed. (defalias 'checkdoc #[nil "\305\306\211\211F\307>@ \203 \310=\203 \311\202 \312\313!\210\f\204, \314\240\210\202<