js-doc.elc

;ELC
;;; Compiled by shant@ultraio on Sat Sep 27 19:36:33 2014
;;; from file /home/shant/.emacs.d/js-doc.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.

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;


(byte-code "\300\301\302\303\304\305\306\307&\210\310\311\312\313\304\301%\210\310\314\312\315\304\301%\210\310\316\312\317\304\301%\210\310\320\312\321\304\301%\207" [custom-declare-group js-doc nil "Insert JsDoc style comment easily." :group comment :prefix "js-doc" custom-declare-variable js-doc-mail-address "" "Author's E-mail address." js-doc-author "Author of the source code." js-doc-license "License of the source code." js-doc-url "Author's Home page URL."] 8)
#@64 JsDoc tag list
This list contains tag name and its description
(defvar js-doc-all-tag-alist '(("augments" . "Indicate this class uses another class as its \"base.\"") ("author" . "Indicate the author of the code being documented.") ("argument" . "Deprecated synonym for @param.") ("borrows that as this" . "Document that class's member as if it were a member of this class.") ("class" . "Provide a description of the class (versus the constructor).") ("constant" . "Indicate that a variable's value is a constant.") ("constructor" . "Identify a function is a constructor.") ("constructs" . "Identicate that a lent function will be used as a constructor.") ("default" . "Describe the default value of a variable.") ("deprecated" . "Indicate use of a variable is no longer supported.") ("description" . "Provide a description (synonym for an untagged first-line).") ("event" . "Describe an event handled by a class.") ("example" . "Provide a small code example, illustrating usage.") ("extends" . "Synonym for @augments.") ("field" . "Indicate that the variable refers to a non-function.") ("fileOverview" . "Provides information about the entire file.") ("function" . "Indicate that the variable refers to a function.") ("ignore" . "Indicate JsDoc Toolkit should ignore the variable.") ("inner" . "Indicate that the variable refers to an inner function (and so is also @private).") ("lends" . "Document that all an object literal's members are members of a given class.") ("license" . "License of the source code.") ("link" . "Like @see but can be used within the text of other tags.") ("method" . "Provide a description of the method") ("memberOf" . "Document that this variable refers to a member of a given class.") ("name" . "Force JsDoc Toolkit to ignore the surrounding code and use the given variable name instead.") ("namespace" . "Document an object literal is being used as a \"namespace.\"") ("param" . "Describe a function's parameter.") ("private" . "Indicate a variable is private (use the -p command line option to include these).") ("property" . "Document a property of a class from within the constructor's doclet.") ("public" . "Indicate an inner variable is public.") ("requires" . "Describe a required resource.") ("returns" . "Describe the return value of a function.") ("see" . "Describe a related resource.") ("since" . "Indicate that a feature has only been available on and after a certain version number.") ("static" . "Indicate that accessing the variable does not require instantiation of its parent.") ("throws" . "Describe the exception that a function might throw.") ("type" . "Describe the expected type of a variable's value or the value returned by a function.") ("version" . "Indicate the release version of this code.")) (#$ . 973))
#@188 JsDoc style file document format.
When the `js-doc-insert-file-doc' is called,
each lines in a list will be formatted by `js-doc-format-string'
and inserted to the top of current buffer.
(defvar js-doc-file-doc-lines '(js-doc-top-line " * @fileOverview\n" " * @name %F\n" " * @author %a\n" " * @license %l\n" js-doc-bottom-line) (#$ . 3748))
#@83 Format and value pair
Format will be replaced its value in `js-doc-format-string'
(defvar js-doc-format-string-alist '(("%F" buffer-name) ("%P" buffer-file-name) ("%a" . js-doc-author) ("%l" . js-doc-license) ("%d" current-time-string) ("%p" . js-doc-current-parameter-name) ("%f" . js-doc-current-function-name)) (#$ . 4096))
(byte-code "\300\301\302\303\304\305%\210\300\306\307\310\304\305%\210\300\311\312\313\304\305%\210\300\314\315\316\304\305%\210\300\317\320\321\304\305%\210\300\322\323\324\304\305%\210\300\325\326\313\304\305%\210\300\327\330\331\304\305%\210\300\332\333\334\304\305%\210\300\335\336\337\304\305%\207" [custom-declare-variable js-doc-top-line "/**\n" "top line of the js-doc style comment." :group js-doc js-doc-description-line " * \n *\n" "description line." js-doc-bottom-line " */\n" "bottom line." js-doc-method-line " * @method %f\n" "method line.\n %f will be replaced with the method name" js-doc-parameter-line " * @param {} %p\n" "parameter line.\n %p will be replaced with the parameter name." js-doc-return-line " * @returns {} \n" "return line." js-doc-throw-line " * @throws {} \n" js-doc-return-regexp "return " "regular expression of return\nWhen the function body contains this pattern,\njs-doc-return-line will be inserted" js-doc-throw-regexp "throw" "regular expression of throw\nWhen the function body contains this pattern,\njs-doc-throw-line will be inserted" js-doc-document-regexp "^[  ]*\\*[^//]" "regular expression of JsDoc comment\nWhen the string ahead of current point matches this pattarn,\njs-doc regards current state as in JsDoc style comment"] 6)
#@155 Format given string and return its result

%F => file name
%P => file path
%a => author name
%d => current date
%p => parameter name
%f => function name

(defalias 'js-doc-format-string #[(fmt) "\305	\305\211\203&@\306\n@\f\"\203\307\310\nA!\311\305\f$A\211\204\n\305\f+\207" [case-fold-search js-doc-format-string-alist pair --dolist-tail-- fmt nil string-match replace-match eval t] 6 (#$ . 5715)])
#@39 Return the last cons cell of the list
(defalias 'js-doc-tail #[(list) "A\203\n\301A!\207@\207" [list js-doc-tail] 2 (#$ . 6135)])
#@30 Pick up symbol-name from str
(defalias 'js-doc-pick-symbol-name #[(str) "\301\302\303\304\305\"\"!\207" [str js-doc-tail delete "" split-string "[^a-zA-Z0-9_$]"] 6 (#$ . 6275)])
#@74 Return t when regexp matched the current buffer string between begin-end
(defalias 'js-doc-block-has-regexp #[(begin end regexp) "\212b\210\303	\n\304\305$)\207" [begin regexp end re-search-forward t 1] 5 (#$ . 6460)])
#@48 Insert specified-style comment top of the file
(defalias 'js-doc-insert-file-doc #[nil "\303b\210\304\211\205\n@\305\306	!!c\210\nA\211\204\304*\207" [js-doc-file-doc-lines line-format --dolist-tail-- 1 nil js-doc-format-string eval] 4 (#$ . 6686) nil])
#@109 Insert JsDoc style comment of the function
The comment style can be custimized via `customize-group js-doc'
(defalias 'js-doc-insert-function-doc #[nil "\306\210\307`!\204\310`!\203\311y\210\306\210\202\306\210\312 \210\306\211`\306\211\211\211\212\313\314!\203<\315\316!$\202G\313\317!\203G\315\316!$\320\321\306\322#\320\323\306\322#S\211V\203\202\324\325\n\"\326\"\306%\211&\203\201&@%\327\330\331%!\322#\210&A\211&\204j*\320\332\306\322#\333	S\316\334#\327\305\335'!\322#\210\327\305\335(!\322#\210$\203\257\327\305\335)!\322#\210\306*\211&\203\324&@\211*+\327\305\335,!\322#\210&A\211&\204\272*\336	-#\203\347\327\305\335.!\322#\210\336	/#\203\371\327\305\3350!\322#\210\327\305\3351!\322#\210\337\321\306\322#\210\340 \210`
\3062\211&\203(
&@\2112c\210&A\211&\204
*\341`\"\210.\313\342!\204:
\337\343!\210\306y\210\306\207" [end begin to from head-of-func document-list nil js-doc-in-comment-p js-doc-blank-line-p -1 beginning-of-defun looking-at "\\([a-zA-Z_][a-zA-Z0-9_]*\\) *: *function" match-string 1 "function +\\([a-zA-Z_][a-zA-Z0-9_]*\\)" search-forward "(" t ")" split-string buffer-substring-no-properties "," add-to-list params js-doc-pick-symbol-name "{" scan-lists 0 js-doc-format-string js-doc-block-has-regexp search-backward beginning-of-line indent-region "/\\*\\*" "/**" js-doc-current-function-name param-block --dolist-tail-- js-doc-top-line js-doc-description-line js-doc-method-line param js-doc-current-parameter-name js-doc-parameter-line js-doc-return-regexp js-doc-return-line js-doc-throw-regexp js-doc-throw-line js-doc-bottom-line document] 8 (#$ . 6956) nil])
(defalias 'js-doc-icompleting-read #[(prompt collection) "\302\303	\304\211#)\207" [iswitchb-make-buflist-hook prompt #[nil "\211\207" [collection iswitchb-temp-buflist] 2] iswitchb-read-buffer nil] 4])
(defalias 'js-doc-make-tag-list #[nil "\304	\304\211\203@\305\300\n@\"\210A\211\204\n*\306!)\207" [taglist js-doc-all-tag-alist tagpair --dolist-tail-- nil add-to-list reverse] 4])
#@59 Return t when the line at the current point is blank line
(defalias 'js-doc-blank-line-p #[(p) "\212\300\301 \210`\302\210`\")\207" [eql beginning-of-line nil] 3 (#$ . 9031)])
#@45 Return t when the point p is in the comment
(defalias 'js-doc-in-comment-p #[(p) "\212\302\211\303 \210`\302\210`\304	\305#\206\304	\306#+\207" [end begin nil beginning-of-line js-doc-block-has-regexp "//" "/\\*"] 4 (#$ . 9214)])
#@48 Return t when the point p is in JsDoc document
(defalias 'js-doc-in-document-p #[(p) "\212b\210\301\302\303\304#\205\305\306\304#?)\207" [p search-backward "/**" nil t search-forward "*/"] 4 (#$ . 9459)])
#@35 Insert a JsDoc tag interactively.
(defalias 'js-doc-insert-tag #[nil "\301c\210\302`!\205!\303\304\305 \306\211\211\211\211&\211\307\230?\205 \310\261)\207" [tag "@" js-doc-in-document-p completing-read "Tag: " js-doc-make-tag-list nil "" " "] 9 (#$ . 9674) nil])
#@24 Describe the JsDoc tag
(defalias 'js-doc-describe-tag #[nil "\306\307\310 \311\312\313 \311\211&\314\211\315\230?\205P\nr\316\317!q\210p\320 \210\311\211\312\211\312\321 \210\322\323!\210+\211\324\325\326	\327	\"A#!\330!\210+*\207" [temp-buffer-show-hook tag default-directory #1=#:old-dir buffer-read-only buffer-file-name completing-read "Tag: " js-doc-make-tag-list nil t word-at-point #[nil "\300\301\302 \"\210\303 \207" [fill-region 0 buffer-size fit-window-to-buffer] 3] "" get-buffer-create "JsDocTagDescription" kill-all-local-variables erase-buffer run-hooks temp-buffer-setup-hook princ format "@%s\n\n%s" assoc internal-temp-output-buffer-show buffer-undo-list inhibit-modification-hooks inhibit-read-only #2=#:buf standard-output js-doc-all-tag-alist] 9 (#$ . 9950) nil])
(provide 'js-doc)