elpa/flycheck-20190503.853/flycheck-autoloads.el

   1 ;;; flycheck-autoloads.el --- automatically extracted autoloads
   2 ;;
   3 ;;; Code:
   4 (add-to-list 'load-path (or (file-name-directory #$) (car load-path)))
   5 \f
   6 ;;;### (autoloads nil "flycheck" "flycheck.el" (23799 54078 879507
   7 ;;;;;;  926000))
   8 ;;; Generated autoloads from flycheck.el
   9
  10 (autoload 'flycheck-manual "flycheck" "\
  11 Open the Flycheck manual.
  12
  13 \(fn)" t nil)
  14
  15 (autoload 'flycheck-mode "flycheck" "\
  16 Minor mode for on-the-fly syntax checking.
  17
  18 When called interactively, toggle `flycheck-mode'.  With prefix
  19 ARG, enable `flycheck-mode' if ARG is positive, otherwise disable
  20 it.
  21
  22 When called from Lisp, enable `flycheck-mode' if ARG is omitted,
  23 nil or positive.  If ARG is `toggle', toggle `flycheck-mode'.
  24 Otherwise behave as if called interactively.
  25
  26 In `flycheck-mode' the buffer is automatically syntax-checked
  27 using the first suitable syntax checker from `flycheck-checkers'.
  28 Use `flycheck-select-checker' to select a checker for the current
  29 buffer manually.
  30
  31 \\{flycheck-mode-map}
  32
  33 \(fn &optional ARG)" t nil)
  34
  35 (defvar global-flycheck-mode nil "\
  36 Non-nil if Global-Flycheck mode is enabled.
  37 See the command `global-flycheck-mode' for a description of this minor mode.
  38 Setting this variable directly does not take effect;
  39 either customize it (see the info node `Easy Customization')
  40 or call the function `global-flycheck-mode'.")
  41
  42 (custom-autoload 'global-flycheck-mode "flycheck" nil)
  43
  44 (autoload 'global-flycheck-mode "flycheck" "\
  45 Toggle Flycheck mode in all buffers.
  46 With prefix ARG, enable Global-Flycheck mode if ARG is positive;
  47 otherwise, disable it.  If called from Lisp, enable the mode if
  48 ARG is omitted or nil.
  49
  50 Flycheck mode is enabled in all buffers where
  51 `flycheck-mode-on-safe' would do it.
  52 See `flycheck-mode' for more information on Flycheck mode.
  53
  54 \(fn &optional ARG)" t nil)
  55
  56 (autoload 'flycheck-define-error-level "flycheck" "\
  57 Define a new error LEVEL with PROPERTIES.
  58
  59 The following PROPERTIES constitute an error level:
  60
  61 `:severity SEVERITY'
  62      A number denoting the severity of this level.  The higher
  63      the number, the more severe is this level compared to other
  64      levels.  Defaults to 0.
  65
  66      The severity is used by `flycheck-error-level-<' to
  67      determine the ordering of errors according to their levels.
  68
  69 `:compilation-level LEVEL'
  70
  71      A number indicating the broad class of messages that errors
  72      at this level belong to: one of 0 (info), 1 (warning), or
  73      2 or nil (error).  Defaults to nil.
  74
  75      This is used by `flycheck-checker-pattern-to-error-regexp'
  76      to map error levels into `compilation-mode''s hierarchy and
  77      to get proper highlighting of errors in `compilation-mode'.
  78
  79 `:overlay-category CATEGORY'
  80      A symbol denoting the overlay category to use for error
  81      highlight overlays for this level.  See Info
  82      node `(elisp)Overlay Properties' for more information about
  83      overlay categories.
  84
  85      A category for an error level overlay should at least define
  86      the `face' property, for error highlighting.  Another useful
  87      property for error level categories is `priority', to
  88      influence the stacking of multiple error level overlays.
  89
  90 `:fringe-bitmap BITMAP'
  91      A fringe bitmap symbol denoting the bitmap to use for fringe
  92      indicators for this level.  See Info node `(elisp)Fringe
  93      Bitmaps' for more information about fringe bitmaps,
  94      including a list of built-in fringe bitmaps.
  95
  96 `:fringe-face FACE'
  97      A face symbol denoting the face to use for fringe indicators
  98      for this level.
  99
 100 `:error-list-face FACE'
 101      A face symbol denoting the face to use for messages of this
 102      level in the error list.  See `flycheck-list-errors'.
 103
 104 \(fn LEVEL &rest PROPERTIES)" nil nil)
 105
 106 (put 'flycheck-define-error-level 'lisp-indent-function '1)
 107
 108 (autoload 'flycheck-define-command-checker "flycheck" "\
 109 Define SYMBOL as syntax checker to run a command.
 110
 111 Define SYMBOL as generic syntax checker via
 112 `flycheck-define-generic-checker', which uses an external command
 113 to check the buffer.  SYMBOL and DOCSTRING are the same as for
 114 `flycheck-define-generic-checker'.
 115
 116 In addition to the properties understood by
 117 `flycheck-define-generic-checker', the following PROPERTIES
 118 constitute a command syntax checker.  Unless otherwise noted, all
 119 properties are mandatory.  Note that the default `:error-filter'
 120 of command checkers is `flycheck-sanitize-errors'.
 121
 122 `:command COMMAND'
 123      The command to run for syntax checking.
 124
 125      COMMAND is a list of the form `(EXECUTABLE [ARG ...])'.
 126
 127      EXECUTABLE is a string with the executable of this syntax
 128      checker.  It can be overridden with the variable
 129      `flycheck-SYMBOL-executable'.  Note that this variable is
 130      NOT implicitly defined by this function.  Use
 131      `flycheck-def-executable-var' to define this variable.
 132
 133      Each ARG is an argument to the executable, either as string,
 134      or as special symbol or form for
 135      `flycheck-substitute-argument', which see.
 136
 137 `:error-patterns PATTERNS'
 138      A list of patterns to parse the output of the `:command'.
 139
 140      Each ITEM in PATTERNS is a list `(LEVEL SEXP ...)', where
 141      LEVEL is a Flycheck error level (see
 142      `flycheck-define-error-level'), followed by one or more RX
 143      `SEXP's which parse an error of that level and extract line,
 144      column, file name and the message.
 145
 146      See `rx' for general information about RX, and
 147      `flycheck-rx-to-string' for some special RX forms provided
 148      by Flycheck.
 149
 150      All patterns are applied in the order of declaration to the
 151      whole output of the syntax checker.  Output already matched
 152      by a pattern will not be matched by subsequent patterns.  In
 153      other words, the first pattern wins.
 154
 155      This property is optional.  If omitted, however, an
 156      `:error-parser' is mandatory.
 157
 158 `:error-parser FUNCTION'
 159      A function to parse errors with.
 160
 161      The function shall accept three arguments OUTPUT CHECKER
 162      BUFFER.  OUTPUT is the syntax checker output as string,
 163      CHECKER the syntax checker that was used, and BUFFER a
 164      buffer object representing the checked buffer.  The function
 165      must return a list of `flycheck-error' objects parsed from
 166      OUTPUT.
 167
 168      This property is optional.  If omitted, it defaults to
 169      `flycheck-parse-with-patterns'.  In this case,
 170      `:error-patterns' is mandatory.
 171
 172 `:standard-input t'
 173      Whether to send the buffer contents on standard input.
 174
 175      If this property is given and has a non-nil value, send the
 176      contents of the buffer on standard input.
 177
 178      Defaults to nil.
 179
 180 Note that you may not give `:start', `:interrupt', and
 181 `:print-doc' for a command checker.  You can give a custom
 182 `:verify' function, though, whose results will be appended to the
 183 default `:verify' function of command checkers.
 184
 185 \(fn SYMBOL DOCSTRING &rest PROPERTIES)" nil nil)
 186
 187 (put 'flycheck-define-command-checker 'lisp-indent-function '1)
 188
 189 (put 'flycheck-define-command-checker 'doc-string-elt '2)
 190
 191 (autoload 'flycheck-def-config-file-var "flycheck" "\
 192 Define SYMBOL as config file variable for CHECKER, with default FILE-NAME.
 193
 194 SYMBOL is declared as customizable variable using `defcustom', to
 195 provide a configuration file for the given syntax CHECKER.
 196 CUSTOM-ARGS are forwarded to `defcustom'.
 197
 198 FILE-NAME is the initial value of the new variable.  If omitted,
 199 the default value is nil.
 200
 201 Use this together with the `config-file' form in the `:command'
 202 argument to `flycheck-define-checker'.
 203
 204 \(fn SYMBOL CHECKER &optional FILE-NAME &rest CUSTOM-ARGS)" nil t)
 205
 206 (put 'flycheck-def-config-file-var 'lisp-indent-function '3)
 207
 208 (autoload 'flycheck-def-option-var "flycheck" "\
 209 Define SYMBOL as option variable with INIT-VALUE for CHECKER.
 210
 211 SYMBOL is declared as customizable variable using `defcustom', to
 212 provide an option for the given syntax CHECKERS (a checker or a
 213 list of checkers).  INIT-VALUE is the initial value of the
 214 variable, and DOCSTRING is its docstring.  CUSTOM-ARGS are
 215 forwarded to `defcustom'.
 216
 217 Use this together with the `option', `option-list' and
 218 `option-flag' forms in the `:command' argument to
 219 `flycheck-define-checker'.
 220
 221 \(fn SYMBOL INIT-VALUE CHECKERS DOCSTRING &rest CUSTOM-ARGS)" nil t)
 222
 223 (put 'flycheck-def-option-var 'lisp-indent-function '3)
 224
 225 (put 'flycheck-def-option-var 'doc-string-elt '4)
 226
 227 ;;;***
 228 \f
 229 ;;;### (autoloads nil nil ("flycheck-buttercup.el" "flycheck-ert.el"
 230 ;;;;;;  "flycheck-pkg.el") (23799 54078 883047 187000))
 231
 232 ;;;***
 233 \f
 234 ;; Local Variables:
 235 ;; version-control: never
 236 ;; no-byte-compile: t
 237 ;; no-update-autoloads: t
 238 ;; End:
 239 ;;; flycheck-autoloads.el ends here