config

Personal configuration.
git clone git://code.dwrz.net/config
Log | Files | Refs

flycheck-autoloads.el (12039B)


      1 ;;; flycheck-autoloads.el --- automatically extracted autoloads (do not edit)   -*- lexical-binding: t -*-
      2 ;; Generated by the `loaddefs-generate' function.
      3 
      4 ;; This file is part of GNU Emacs.
      5 
      6 ;;; Code:
      7 
      8 (add-to-list 'load-path (or (and load-file-name (directory-file-name (file-name-directory load-file-name))) (car load-path)))
      9 
     10 
     11 
     12 ;;; Generated autoloads from flycheck.el
     13 
     14 (autoload 'flycheck-manual "flycheck" "\
     15 Open the Flycheck manual." t)
     16 (autoload 'flycheck-quick-help "flycheck" "\
     17 Display brief Flycheck help." t)
     18 (autoload 'flycheck-mode "flycheck" "\
     19 Flycheck is a minor mode for on-the-fly syntax checking.
     20 
     21 In `flycheck-mode' the buffer is automatically syntax-checked
     22 using the first suitable syntax checker from `flycheck-checkers'.
     23 Use `flycheck-select-checker' to select a checker for the current
     24 buffer manually.
     25 
     26 If you run into issues, use `\\[flycheck-verify-setup]' to get help.
     27 
     28 Flycheck supports many languages out of the box, and many
     29 additional ones are available on MELPA.  Adding new ones is very
     30 easy.  Complete documentation is available online at URL
     31 `https://www.flycheck.org/en/latest/'.  Please report issues and
     32 request features at URL `https://github.com/flycheck/flycheck'.
     33 
     34 Flycheck displays its status in the mode line.  In the default
     35 configuration, it looks like this:
     36 
     37 `FlyC'     This buffer has not been checked yet.
     38 `FlyC*'    Flycheck is running.  Expect results soon!
     39 `FlyC:0'   Last check resulted in no errors and no warnings.
     40 `FlyC:3|5' This buffer contains three errors and five warnings.
     41            Use `\\[flycheck-list-errors]' to see the list.
     42 `FlyC-'    Flycheck doesn't have a checker for this buffer.
     43 
     44 You may also see the following icons:
     45 `FlyC!'    The checker crashed.
     46 `FlyC.'    The last syntax check was manually interrupted.
     47 `FlyC?'    The checker did something unexpected, like exiting with 1
     48            but returning no errors.
     49 
     50 The following keybindings are available in `flycheck-mode':
     51 
     52 \\{flycheck-mode-map}
     53 (you can change the prefix by customizing
     54 `flycheck-keymap-prefix')
     55 
     56 If called interactively, enable Flycheck mode if ARG is positive,
     57 and disable it if ARG is zero or negative.  If called from Lisp,
     58 also enable the mode if ARG is omitted or nil, and toggle it if
     59 ARG is ‘toggle’; disable the mode otherwise.
     60 
     61 (fn &optional ARG)" t)
     62 (put 'global-flycheck-mode 'globalized-minor-mode t)
     63 (defvar global-flycheck-mode nil "\
     64 Non-nil if Global Flycheck mode is enabled.
     65 See the `global-flycheck-mode' command
     66 for a description of this minor mode.
     67 Setting this variable directly does not take effect;
     68 either customize it (see the info node `Easy Customization')
     69 or call the function `global-flycheck-mode'.")
     70 (custom-autoload 'global-flycheck-mode "flycheck" nil)
     71 (autoload 'global-flycheck-mode "flycheck" "\
     72 Toggle Flycheck mode in all buffers.
     73 With prefix ARG, enable Global Flycheck mode if ARG is positive; otherwise,
     74 disable it.
     75 
     76 If called from Lisp, toggle the mode if ARG is `toggle'.
     77 Enable the mode if ARG is nil, omitted, or is a positive number.
     78 Disable the mode if ARG is a negative number.
     79 
     80 Flycheck mode is enabled in all buffers where `flycheck-mode-on-safe' would do
     81 it.
     82 
     83 See `flycheck-mode' for more information on Flycheck mode.
     84 
     85 (fn &optional ARG)" t)
     86 (autoload 'flycheck-define-error-level "flycheck" "\
     87 Define a new error LEVEL with PROPERTIES.
     88 
     89 The following PROPERTIES constitute an error level:
     90 
     91 `:severity SEVERITY'
     92      A number denoting the severity of this level.  The higher
     93      the number, the more severe is this level compared to other
     94      levels.  Defaults to 0; info is -10, warning is 10, and
     95      error is 100.
     96 
     97      The severity is used by `flycheck-error-level-<' to
     98      determine the ordering of errors according to their levels.
     99 
    100 `:compilation-level LEVEL'
    101 
    102      A number indicating the broad class of messages that errors
    103      at this level belong to: one of 0 (info), 1 (warning), or
    104      2 or nil (error).  Defaults to nil.
    105 
    106      This is used by `flycheck-checker-pattern-to-error-regexp'
    107      to map error levels into `compilation-mode''s hierarchy and
    108      to get proper highlighting of errors in `compilation-mode'.
    109 
    110 `:overlay-category CATEGORY'
    111      A symbol denoting the overlay category to use for error
    112      highlight overlays for this level.  See Info
    113      node `(elisp)Overlay Properties' for more information about
    114      overlay categories.
    115 
    116      A category for an error level overlay should at least define
    117      the `face' property, for error highlighting.  Another useful
    118      property for error level categories is `priority', to
    119      influence the stacking of multiple error level overlays.
    120 
    121 `:fringe-bitmap BITMAPS'
    122      A fringe bitmap symbol denoting the bitmap to use for fringe
    123      indicators for this level, or a cons of two bitmaps (one for
    124      narrow fringes and one for wide fringes).  See Info node
    125      `(elisp)Fringe Bitmaps' for more information about fringe
    126      bitmaps, including a list of built-in fringe bitmaps.
    127 
    128 `:fringe-face FACE'
    129      A face symbol denoting the face to use for fringe indicators
    130      for this level.
    131 
    132 `:margin-spec SPEC'
    133      A display specification indicating what to display in the
    134      margin when `flycheck-indication-mode' is `left-margin' or
    135      `right-margin'.  See Info node `(elisp)Displaying in the
    136      Margins'.  If omitted, Flycheck generates an image spec from
    137      the fringe bitmap.
    138 
    139 `:error-list-face FACE'
    140      A face symbol denoting the face to use for messages of this
    141      level in the error list.  See `flycheck-list-errors'.
    142 
    143 (fn LEVEL &rest PROPERTIES)")
    144 (function-put 'flycheck-define-error-level 'lisp-indent-function 1)
    145 (autoload 'flycheck-define-command-checker "flycheck" "\
    146 Define SYMBOL as syntax checker to run a command.
    147 
    148 Define SYMBOL as generic syntax checker via
    149 `flycheck-define-generic-checker', which uses an external command
    150 to check the buffer.  SYMBOL and DOCSTRING are the same as for
    151 `flycheck-define-generic-checker'.
    152 
    153 In addition to the properties understood by
    154 `flycheck-define-generic-checker', the following PROPERTIES
    155 constitute a command syntax checker.  Unless otherwise noted, all
    156 properties are mandatory.  Note that the default `:error-filter'
    157 of command checkers is `flycheck-sanitize-errors'.
    158 
    159 `:command COMMAND'
    160      The command to run for syntax checking.
    161 
    162      COMMAND is a list of the form `(EXECUTABLE [ARG ...])'.
    163 
    164      EXECUTABLE is a string with the executable of this syntax
    165      checker.  It can be overridden with the variable
    166      `flycheck-SYMBOL-executable'.  Note that this variable is
    167      NOT implicitly defined by this function.  Use
    168      `flycheck-def-executable-var' to define this variable.
    169 
    170      Each ARG is an argument to the executable, either as string,
    171      or as special symbol or form for
    172      `flycheck-substitute-argument', which see.
    173 
    174 `:error-patterns PATTERNS'
    175      A list of patterns to parse the output of the `:command'.
    176 
    177      Each ITEM in PATTERNS is a list `(LEVEL SEXP ...)', where
    178      LEVEL is a Flycheck error level (see
    179      `flycheck-define-error-level'), followed by one or more RX
    180      `SEXP's which parse an error of that level and extract line,
    181      column, file name and the message.
    182 
    183      See `rx' for general information about RX, and
    184      `flycheck-rx-to-string' for some special RX forms provided
    185      by Flycheck.
    186 
    187      All patterns are applied in the order of declaration to the
    188      whole output of the syntax checker.  Output already matched
    189      by a pattern will not be matched by subsequent patterns.  In
    190      other words, the first pattern wins.
    191 
    192      This property is optional.  If omitted, however, an
    193      `:error-parser' is mandatory.
    194 
    195 `:error-parser FUNCTION'
    196      A function to parse errors with.
    197 
    198      The function shall accept three arguments OUTPUT CHECKER
    199      BUFFER.  OUTPUT is the syntax checker output as string,
    200      CHECKER the syntax checker that was used, and BUFFER a
    201      buffer object representing the checked buffer.  The function
    202      must return a list of `flycheck-error' objects parsed from
    203      OUTPUT.
    204 
    205      This property is optional.  If omitted, it defaults to
    206      `flycheck-parse-with-patterns'.  In this case,
    207      `:error-patterns' is mandatory.
    208 
    209 `:standard-input t'
    210      Whether to send the buffer contents on standard input.
    211 
    212      If this property is given and has a non-nil value, send the
    213      contents of the buffer on standard input.
    214 
    215      Some checkers that support reading from standard input have
    216      a separate flag to indicate the name of the file whose
    217      contents are being passed on standard input (typically
    218      `stdin-filename').  In that case, use the `(option)' form in
    219      `:command' to pass the value of variable `buffer-file-name'
    220      when the current buffer has a file name (that is,
    221      use `option \"--stdin-file-name\" buffer-file-name').
    222 
    223      For buffers not backed by files, checkers that support input
    224      on stdin typically report a file name like `-' or `<stdin>'.
    225      Make sure your error parser or patterns expect these file
    226      names (for example, use `(or \"<stdin>\" (file-name))') or
    227      call `flycheck-remove-error-file-names' in a custom
    228      `:error-filter'.
    229 
    230      Defaults to nil.
    231 
    232 Note that you may not give `:start', `:interrupt', and
    233 `:print-doc' for a command checker.  You can give a custom
    234 `:verify' function, though, whose results will be appended to the
    235 default `:verify' function of command checkers.
    236 
    237 (fn SYMBOL DOCSTRING &rest PROPERTIES)")
    238 (function-put 'flycheck-define-command-checker 'lisp-indent-function 1)
    239 (function-put 'flycheck-define-command-checker 'doc-string-elt 2)
    240 (autoload 'flycheck-def-config-file-var "flycheck" "\
    241 Define SYMBOL as config file variable for CHECKER, with default FILE-NAME.
    242 
    243 SYMBOL is declared as customizable variable using `defcustom', to
    244 provide configuration files for the given syntax CHECKER.
    245 CUSTOM-ARGS are forwarded to `defcustom'.
    246 
    247 FILE-NAME is the initial value of the new variable.  If omitted,
    248 the default value is nil.  It can be either a string or a list of
    249 strings.
    250 
    251 Use this together with the `config-file' form in the `:command'
    252 argument to `flycheck-define-checker'.
    253 
    254 (fn SYMBOL CHECKER &optional FILE-NAME &rest CUSTOM-ARGS)" nil t)
    255 (function-put 'flycheck-def-config-file-var 'lisp-indent-function 3)
    256 (autoload 'flycheck-def-option-var "flycheck" "\
    257 Define SYMBOL as option variable with INIT-VALUE for CHECKER.
    258 
    259 SYMBOL is declared as customizable variable using `defcustom', to
    260 provide an option for the given syntax CHECKERS (a checker or a
    261 list of checkers).  INIT-VALUE is the initial value of the
    262 variable, and DOCSTRING is its docstring.  CUSTOM-ARGS are
    263 forwarded to `defcustom'.
    264 
    265 Use this together with the `option', `option-list' and
    266 `option-flag' forms in the `:command' argument to
    267 `flycheck-define-checker'.
    268 
    269 (fn SYMBOL INIT-VALUE CHECKERS DOCSTRING &rest CUSTOM-ARGS)" nil t)
    270 (function-put 'flycheck-def-option-var 'lisp-indent-function 3)
    271 (function-put 'flycheck-def-option-var 'doc-string-elt 4)
    272 (autoload 'flycheck-define-checker "flycheck" "\
    273 Define SYMBOL as command syntax checker with DOCSTRING and PROPERTIES.
    274 
    275 Like `flycheck-define-command-checker', but PROPERTIES must not
    276 be quoted.  Also, implicitly define the executable variable for
    277 SYMBOL with `flycheck-def-executable-var'.
    278 
    279 (fn SYMBOL DOCSTRING &rest PROPERTIES)" nil t)
    280 (function-put 'flycheck-define-checker 'lisp-indent-function 1)
    281 (function-put 'flycheck-define-checker 'doc-string-elt 2)
    282 (register-definition-prefixes "flycheck" '("flycheck-" "help-flycheck-checker-d" "list-flycheck-errors"))
    283 
    284 
    285 ;;; Generated autoloads from flycheck-buttercup.el
    286 
    287 (register-definition-prefixes "flycheck-buttercup" '("flycheck-buttercup-format-error-list"))
    288 
    289 
    290 ;;; Generated autoloads from flycheck-ert.el
    291 
    292 (register-definition-prefixes "flycheck-ert" '("flycheck-er"))
    293 
    294 ;;; End of scraped data
    295 
    296 (provide 'flycheck-autoloads)
    297 
    298 ;; Local Variables:
    299 ;; version-control: never
    300 ;; no-byte-compile: t
    301 ;; no-update-autoloads: t
    302 ;; no-native-compile: t
    303 ;; coding: utf-8-emacs-unix
    304 ;; End:
    305 
    306 ;;; flycheck-autoloads.el ends here