[elpa] externals/inspector 0c02fd712f: README: generated docs

[ELPA Syncer]

branch: externals/inspector
commit 0c02fd712ff89006227838e18a4685678abd9ba8
Author: Mariano Montone <marianomontone@gmail.com>
Commit: Mariano Montone <marianomontone@gmail.com>

    README: generated docs
---
 README.md | 159 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 159 insertions(+)

diff --git a/README.md b/README.md
index 897490176f..df3bcfed85 100644
--- a/README.md
+++ b/README.md
@@ -88,3 +88,162 @@ and then use `C-u C-x C-e` and `C-u M-:` as alternatives to 
`eval-last-sexp` and
 )
 (add-hook 'inspector-mode-hook #'inspector--set-evil-key-binding)
 ```
+
+## API
+
+### Customisation groups
+
+- **inspector-faces** 
+
+    Emacs Lisp inspector faces\.
+
+- **inspector** 
+
+    Emacs Lisp inspector customizations\.
+
+### Customisations
+
+- **inspector-switch-to-buffer** `t` (boolean)
+
+    Use \`switch\-to\-buffer\-other\-window' after an inspector buffer is 
opened\.
+
+- **inspector-pp-use-max-width** `(if (boundp 'pp-use-max-width) (symbol-value 
'pp-use-max-width) nil)` (boolean)
+
+    If non\-nil, \`pp'\-related functions will try to fold lines\.
+    The target width is given by the \`pp\-max\-width' variable\.
+
+- **inspector-pp-max-width** `(if (boundp 'pp-max-width) (symbol-value 
'pp-max-width) window width)` ((choice (const :tag none nil) (const :tag window 
width t) number))
+
+    Max width to use when inspector pretty printing of objects\.
+    If nil, there's no max width\.  If t, use the window width\.
+    Otherwise this should be a number\.
+    See \`pp\-max\-width'
+
+- **inspector-alist-test-function** `'inspector--alistp` (symbol)
+
+    Function used by the inspector to determine if a list is an association 
list\.
+
+- **inspector-plist-test-function** `'inspector--plistp` (symbol)
+
+    Function used by the inspector to determine if a list is a property list\.
+
+- **inspector-slice-size** `100` (integer)
+
+    Size of sequence slices in inspector\.
+
+- **inspector-use-font-lock-faces** `t` (boolean)
+
+    Use font\-lock faces in inspector, instead of button faces\.
+
+- **inspector-use-specialized-inspectors-for-lists** `t` (boolean)
+
+    Whether to use specialized inspectors for plists and alists\.
+
+- **inspector-show-documentation** `t` (boolean)
+
+    Whether to show variables and function documentation or not\.
+
+- **inspector-truncation-limit** `500` (integer)
+
+    Control truncation limit in inspector\.
+
+### Functions
+
+- **inspector-inspect-edebug-expression** (expr)
+
+    Evaluate EXPR in \`edebug\-mode', and inspect the result\.
+
+- **inspector-inspect-in-stack-frame** (exp)
+
+    Inspect an expression, in an environment like that outside the debugger\.
+    The environment used is the one when entering the activation frame at 
point\.
+
+- **inspector-inspect-stack-frame** ()
+
+    Inspect current frame and locals in debugger backtrace\.
+
+- **inspector-inspect-debugger-return-value** ()
+
+    Inspect the current return value in the debugger\.
+
+- **inspector-inspect-debugger-local** (varname)
+
+    Inspect local variable named VARNAME of frame at point in debugger 
backtrace\.
+
+- **inspector-inspect-debugger-locals** ()
+
+    Inspect local variables of the frame at point in debugger backtrace\.
+
+- **inspector-pprint-inspected-object** ()
+
+    Pretty print the object being inspected\.
+
+- **inspector-inspect-region** (start end)
+
+    Evaluate the region from START TO END and inspect the result\.
+
+- **inspector-inspect-defun** ()
+
+    Evaluate the top s\-exp \- simmilar the effect
+     of M\-x or eval\-defun and inspect the result
+
+- **inspector-inspect-last-sexp** ()
+
+    Evaluate sexp before point and inspect the result\.
+
+- **inspector-pop** ()
+
+    Inspect previous object in inspector history\.
+
+- **inspector-quit** ()
+
+    Quit the Emacs inspector\.
+
+- **inspector-refresh** ()
+
+    Refresh inspector buffer\.
+
+- **inspector-inspect** (object &optional preserve-history)
+
+    Top\-level function for inspecting OBJECTs\.
+    When PRESERVE\-HISTORY is T, inspector history is not cleared\.
+
+- **inspector-inspect-expression** (exp)
+
+    Evaluate EXP and inspect its result\.
+
+- **inspector-make-inspector-buffer** ()
+
+    Create an inspector buffer\.
+
+### Variables
+
+- **inspector-tool-bar-map** `(let ((map (make-sparse-keymap))) 
(tool-bar-local-item-from-menu 'inspector-pop left-arrow map inspector-mode-map 
:rtl left-arrow :label Back :vert-only t) (tool-bar-local-item-from-menu 
'inspector-quit exit map inspector-mode-map :vert-only t) map)`
+
+- **inspector-mode-map** `(let ((map (make-keymap))) (define-key map q 
#'inspector-quit) (define-key map l #'inspector-pop) (define-key map e 
#'eval-expression) (define-key map n #'forward-button) (define-key map p 
#'backward-button) (define-key map P #'inspector-pprint-inspected-object) 
(define-key map g #'inspector-refresh) map)`
+
+### Faces
+
+- **inspector-type-face** 
+
+    Face for type description in inspector\.
+
+- **inspector-action-face** 
+
+    Face for labels of inspector actions\.
+
+- **inspector-value-face** 
+
+    Face for things which can themselves be inspected\.
+
+- **inspector-label-face** 
+
+    Face for labels in the inspector\.
+
+- **inspector-title-face** 
+
+    Face for title describing object\.
+
+- **inspector-button-face** 
+
+    Face for inspector buttons\.