mirror of
https://github.com/zdharma-continuum/zinit.git
synced 2026-09-10 07:36:38 -04:00
zsdoc: Update code documentation
This commit is contained in:
Sebastian Gniazdowski
parent
968f4d1a2f
commit
9a646b4fe6
|
|
@ -28,7 +28,9 @@ FUNCTIONS
|
|||
-zplg-compiled
|
||||
-zplg-compinit
|
||||
-zplg-compute-ice
|
||||
-zplg-confirm
|
||||
-zplg-create
|
||||
-zplg-delete
|
||||
-zplg-diff-env-compute
|
||||
-zplg-diff-functions-compute
|
||||
-zplg-diff-options-compute
|
||||
|
|
@ -400,6 +402,25 @@ Called by:
|
|||
-zplg-update-or-status-snippet
|
||||
-zplg-update-or-status
|
||||
|
||||
-zplg-confirm
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
____
|
||||
# Prints given question, waits for "y" key, evals
|
||||
# given expression if "y" obtained
|
||||
#
|
||||
# $1 - question
|
||||
# $2 - expression
|
||||
____
|
||||
|
||||
Has 5 line(s). Doesn't call other functions.
|
||||
|
||||
Uses feature(s): _eval_, _read_
|
||||
|
||||
Called by:
|
||||
|
||||
-zplg-delete
|
||||
|
||||
-zplg-create
|
||||
~~~~~~~~~~~~
|
||||
|
||||
|
|
@ -421,6 +442,31 @@ Has 61 line(s). Calls functions:
|
|||
|
||||
Uses feature(s): _vared_
|
||||
|
||||
Called by:
|
||||
|
||||
zplugin.zsh/zplugin
|
||||
|
||||
-zplg-delete
|
||||
~~~~~~~~~~~~
|
||||
|
||||
____
|
||||
# Deletes plugin's or snippet's directory (in Zplugin's home directory).
|
||||
#
|
||||
# User-action entry point.
|
||||
#
|
||||
# $1 - snippet URL or plugin spec (4 formats: user---plugin, user/plugin, user, plugin)
|
||||
# $2 - plugin (only when $1 - i.e. user - given)
|
||||
____
|
||||
|
||||
Has 28 line(s). Calls functions:
|
||||
|
||||
-zplg-delete
|
||||
|-- -zplg-confirm
|
||||
|-- zplugin-side.zsh/-zplg-exists-physically-message
|
||||
|-- zplugin-side.zsh/-zplg-shands-exp
|
||||
|-- zplugin-side.zsh/-zplg-two-paths
|
||||
`-- zplugin.zsh/-zplg-any-to-user-plugin
|
||||
|
||||
Called by:
|
||||
|
||||
zplugin.zsh/zplugin
|
||||
|
|
@ -435,7 +481,7 @@ ____
|
|||
# $1 - user/plugin
|
||||
____
|
||||
|
||||
Has 28 line(s). Doesn't call other functions.
|
||||
Has 30 line(s). Doesn't call other functions.
|
||||
|
||||
Called by:
|
||||
|
||||
|
|
@ -452,7 +498,7 @@ ____
|
|||
# $1 - user/plugin
|
||||
____
|
||||
|
||||
Has 18 line(s). Doesn't call other functions.
|
||||
Has 19 line(s). Doesn't call other functions.
|
||||
|
||||
Called by:
|
||||
|
||||
|
|
@ -469,7 +515,7 @@ ____
|
|||
# $1 - user/plugin
|
||||
____
|
||||
|
||||
Has 18 line(s). Doesn't call other functions.
|
||||
Has 17 line(s). Doesn't call other functions.
|
||||
|
||||
Called by:
|
||||
|
||||
|
|
@ -487,7 +533,7 @@ ____
|
|||
# $1 - user/plugin
|
||||
____
|
||||
|
||||
Has 27 line(s). Doesn't call other functions.
|
||||
Has 28 line(s). Doesn't call other functions.
|
||||
|
||||
Called by:
|
||||
|
||||
|
|
@ -624,7 +670,7 @@ ____
|
|||
# $1 - user/plugin (i.e. uspl2 format of plugin-spec)
|
||||
____
|
||||
|
||||
Has 33 line(s). Doesn't call other functions.
|
||||
Has 34 line(s). Doesn't call other functions.
|
||||
|
||||
Called by:
|
||||
|
||||
|
|
@ -711,7 +757,7 @@ ____
|
|||
# User-action entry point.
|
||||
____
|
||||
|
||||
Has 41 line(s). Doesn't call other functions.
|
||||
Has 43 line(s). Doesn't call other functions.
|
||||
|
||||
Called by:
|
||||
|
||||
|
|
@ -1138,7 +1184,7 @@ ____
|
|||
# $2 - plugin (only when $1 - i.e. user - given)
|
||||
____
|
||||
|
||||
Has 209 line(s). Calls functions:
|
||||
Has 228 line(s). Calls functions:
|
||||
|
||||
-zplg-unload
|
||||
|-- -zplg-clear-report-for
|
||||
|
|
@ -1159,7 +1205,7 @@ Has 209 line(s). Calls functions:
|
|||
|-- zplugin.zsh/-zplg-clear-debug-report
|
||||
`-- zplugin.zsh/-zplg-unregister-plugin
|
||||
|
||||
Uses feature(s): _bindkey_, _unalias_, _unfunction_, _zle_, _zstyle_
|
||||
Uses feature(s): _alias_, _bindkey_, _unalias_, _unfunction_, _zle_, _zstyle_
|
||||
|
||||
Called by:
|
||||
|
||||
|
|
@ -1180,7 +1226,7 @@ ____
|
|||
# $3 - plugin (only when $1 - i.e. user - given)
|
||||
____
|
||||
|
||||
Has 97 line(s). Calls functions:
|
||||
Has 93 line(s). Calls functions:
|
||||
|
||||
-zplg-update-or-status
|
||||
|-- -zplg-at-eval
|
||||
|
|
@ -1196,6 +1242,7 @@ Has 97 line(s). Calls functions:
|
|||
|-- zplugin-install.zsh/-zplg-setup-plugin-dir
|
||||
|-- zplugin-side.zsh/-zplg-any-colorify-as-uspl2
|
||||
|-- zplugin-side.zsh/-zplg-exists-physically-message
|
||||
|-- zplugin-side.zsh/-zplg-store-ices
|
||||
`-- zplugin.zsh/-zplg-any-to-user-plugin
|
||||
|
||||
Uses feature(s): _source_
|
||||
|
|
@ -1233,6 +1280,7 @@ Has 55 line(s). Calls functions:
|
|||
| |-- zplugin-install.zsh/-zplg-setup-plugin-dir
|
||||
| |-- zplugin-side.zsh/-zplg-any-colorify-as-uspl2
|
||||
| |-- zplugin-side.zsh/-zplg-exists-physically-message
|
||||
| |-- zplugin-side.zsh/-zplg-store-ices
|
||||
| `-- zplugin.zsh/-zplg-any-to-user-plugin
|
||||
|-- -zplg-update-or-status-snippet
|
||||
| |-- -zplg-compute-ice
|
||||
|
|
@ -1257,7 +1305,7 @@ ____
|
|||
# $2 - snippet URL
|
||||
____
|
||||
|
||||
Has 18 line(s). Calls functions:
|
||||
Has 19 line(s). Calls functions:
|
||||
|
||||
-zplg-update-or-status-snippet
|
||||
|-- -zplg-compute-ice
|
||||
|
|
|
|||
|
|
@ -97,7 +97,7 @@ ____
|
|||
# This is used to provide a layer of support for Oh-My-Zsh and Prezto.
|
||||
____
|
||||
|
||||
Has 103 line(s). Calls functions:
|
||||
Has 111 line(s). Calls functions:
|
||||
|
||||
-zplg-download-snippet
|
||||
|-- -zplg-at-eval
|
||||
|
|
@ -107,7 +107,8 @@ Has 103 line(s). Calls functions:
|
|||
| |-- zplugin-side.zsh/-zplg-any-colorify-as-uspl2
|
||||
| |-- zplugin-side.zsh/-zplg-exists-physically-message
|
||||
| `-- zplugin.zsh/-zplg-any-to-user-plugin
|
||||
`-- -zplg-mirror-using-svn
|
||||
|-- -zplg-mirror-using-svn
|
||||
`-- zplugin-side.zsh/-zplg-store-ices
|
||||
|
||||
Uses feature(s): _eval_, _zcompile_
|
||||
|
||||
|
|
@ -235,7 +236,7 @@ ____
|
|||
# $2 - plugin
|
||||
____
|
||||
|
||||
Has 129 line(s). Calls functions:
|
||||
Has 124 line(s). Calls functions:
|
||||
|
||||
-zplg-setup-plugin-dir
|
||||
|-- -zplg-compile-plugin
|
||||
|
|
@ -248,7 +249,8 @@ Has 129 line(s). Calls functions:
|
|||
| |-- zplugin-side.zsh/-zplg-any-colorify-as-uspl2
|
||||
| |-- zplugin-side.zsh/-zplg-exists-physically-message
|
||||
| `-- zplugin.zsh/-zplg-any-to-user-plugin
|
||||
`-- zplugin-side.zsh/-zplg-any-colorify-as-uspl2
|
||||
|-- zplugin-side.zsh/-zplg-any-colorify-as-uspl2
|
||||
`-- zplugin-side.zsh/-zplg-store-ices
|
||||
|
||||
Uses feature(s): _eval_
|
||||
|
||||
|
|
|
|||
|
|
@ -18,6 +18,7 @@ FUNCTIONS
|
|||
-zplg-exists-physically-message
|
||||
-zplg-first
|
||||
-zplg-shands-exp
|
||||
-zplg-store-ices
|
||||
-zplg-two-paths
|
||||
|
||||
DETAILS
|
||||
|
|
@ -116,6 +117,7 @@ Called by:
|
|||
|
||||
zplugin-autoload.zsh/-zplg-cd
|
||||
zplugin-autoload.zsh/-zplg-changes
|
||||
zplugin-autoload.zsh/-zplg-delete
|
||||
zplugin-autoload.zsh/-zplg-edit
|
||||
zplugin-autoload.zsh/-zplg-glance
|
||||
zplugin-autoload.zsh/-zplg-stress
|
||||
|
|
@ -166,12 +168,32 @@ Called by:
|
|||
-zplg-exists-physically-message
|
||||
-zplg-exists-physically
|
||||
zplugin-autoload.zsh/-zplg-cd
|
||||
zplugin-autoload.zsh/-zplg-delete
|
||||
|
||||
-zplg-store-ices
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
____
|
||||
# Saves ice mods in given hash onto disk.
|
||||
#
|
||||
# $1 - directory where to create / delete files
|
||||
# $2 - name of hash that holds values
|
||||
# $3 - additional keys of hash to store, space separated
|
||||
# $4 - additional keys of hash to store, empty-meaningful ices, space separated
|
||||
____
|
||||
|
||||
Has 16 line(s). Doesn't call other functions.
|
||||
|
||||
Called by:
|
||||
|
||||
zplugin-autoload.zsh/-zplg-update-or-status
|
||||
zplugin-install.zsh/-zplg-download-snippet
|
||||
zplugin-install.zsh/-zplg-setup-plugin-dir
|
||||
|
||||
-zplg-two-paths
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
____
|
||||
# FUNCTION: -zplg-two-paths()
|
||||
# Obtains a snippet URL without specification if it is an SVN URL (points to
|
||||
# directory) or regular URL (points to file), returns 2 possible paths for
|
||||
# further examination
|
||||
|
|
@ -183,4 +205,5 @@ Called by:
|
|||
|
||||
zplugin-autoload.zsh/-zplg-cd
|
||||
zplugin-autoload.zsh/-zplg-compute-ice
|
||||
zplugin-autoload.zsh/-zplg-delete
|
||||
|
||||
|
|
|
|||
|
|
@ -41,6 +41,7 @@ FUNCTIONS
|
|||
-zplg-prepare-home
|
||||
-zplg-register-plugin
|
||||
-zplg-run-task
|
||||
-zplg-service
|
||||
-zplg-shadow-off
|
||||
-zplg-shadow-on
|
||||
-zplg-submit-turbo
|
||||
|
|
@ -59,7 +60,7 @@ DETAILS
|
|||
Script Body
|
||||
~~~~~~~~~~~
|
||||
|
||||
Has 117 line(s). Calls functions:
|
||||
Has 121 line(s). Calls functions:
|
||||
|
||||
Script-Body
|
||||
|-- -zplg-prepare-home
|
||||
|
|
@ -119,7 +120,7 @@ ____
|
|||
# run custom `autoload' function, that doesn't need FPATH.
|
||||
____
|
||||
|
||||
Has 41 line(s). Calls functions:
|
||||
Has 38 line(s). Calls functions:
|
||||
|
||||
--zplg-shadow-autoload
|
||||
`-- -zplg-add-report
|
||||
|
|
@ -171,7 +172,7 @@ ____
|
|||
# The hijacking is to gather report data (which is used in unload).
|
||||
____
|
||||
|
||||
Has 38 line(s). Calls functions:
|
||||
Has 40 line(s). Calls functions:
|
||||
|
||||
--zplg-shadow-zle
|
||||
`-- -zplg-add-report
|
||||
|
|
@ -208,7 +209,7 @@ ____
|
|||
# $2, ... - the text
|
||||
____
|
||||
|
||||
Has 14 line(s). Doesn't call other functions.
|
||||
Has 8 line(s). Doesn't call other functions.
|
||||
|
||||
Called by:
|
||||
|
||||
|
|
@ -244,6 +245,7 @@ Called by:
|
|||
zplugin-autoload.zsh/-zplg-compile-uncompile-all
|
||||
zplugin-autoload.zsh/-zplg-compiled
|
||||
zplugin-autoload.zsh/-zplg-create
|
||||
zplugin-autoload.zsh/-zplg-delete
|
||||
zplugin-autoload.zsh/-zplg-edit
|
||||
zplugin-autoload.zsh/-zplg-find-completions-of-plugin
|
||||
zplugin-autoload.zsh/-zplg-glance
|
||||
|
|
@ -371,7 +373,7 @@ ____
|
|||
# $2 - command, can be "begin" or "end"
|
||||
____
|
||||
|
||||
Has 18 line(s). Doesn't call other functions.
|
||||
Has 17 line(s). Doesn't call other functions.
|
||||
|
||||
Called by:
|
||||
|
||||
|
|
@ -409,7 +411,7 @@ ____
|
|||
# $2 - command, can be "begin" or "end"
|
||||
____
|
||||
|
||||
Has 6 line(s). Doesn't call other functions.
|
||||
Has 5 line(s). Doesn't call other functions.
|
||||
|
||||
Called by:
|
||||
|
||||
|
|
@ -479,7 +481,7 @@ ____
|
|||
# $2 - plugin name, if the third format is used
|
||||
____
|
||||
|
||||
Has 20 line(s). Calls functions:
|
||||
Has 21 line(s). Calls functions:
|
||||
|
||||
-zplg-load
|
||||
|-- -zplg-any-to-user-plugin
|
||||
|
|
@ -503,6 +505,7 @@ Uses feature(s): _eval_, _source_
|
|||
Called by:
|
||||
|
||||
-zplg-run-task
|
||||
-zplg-service
|
||||
zplugin
|
||||
|
||||
-zplg-load-plugin
|
||||
|
|
@ -516,7 +519,7 @@ ____
|
|||
# $3 - mode (light or load)
|
||||
____
|
||||
|
||||
Has 65 line(s). Calls functions:
|
||||
Has 64 line(s). Calls functions:
|
||||
|
||||
-zplg-load-plugin
|
||||
|-- -zplg-add-report
|
||||
|
|
@ -546,7 +549,7 @@ ____
|
|||
# $4 - "-u" if invoked by Zplugin to only update snippet
|
||||
____
|
||||
|
||||
Has 88 line(s). Calls functions:
|
||||
Has 100 line(s). Calls functions:
|
||||
|
||||
-zplg-load-snippet
|
||||
|-- -zplg-pack-ice
|
||||
|
|
@ -557,6 +560,7 @@ Uses feature(s): _autoload_, _eval_, _source_, _unfunction_, _zparseopts_
|
|||
Called by:
|
||||
|
||||
-zplg-run-task
|
||||
-zplg-service
|
||||
pmodload
|
||||
zplugin
|
||||
zplugin-autoload.zsh/-zplg-update-or-status-snippet
|
||||
|
|
@ -587,12 +591,11 @@ ____
|
|||
# if they already exist.
|
||||
____
|
||||
|
||||
Has 21 line(s). Doesn't call other functions.
|
||||
Has 25 line(s). Doesn't call other functions.
|
||||
|
||||
Called by:
|
||||
|
||||
Script-Body
|
||||
zplugin
|
||||
|
||||
-zplg-register-plugin
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
@ -606,7 +609,7 @@ Called by:
|
|||
-zplg-run-task
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
Has 26 line(s). Calls functions:
|
||||
Has 32 line(s). Calls functions:
|
||||
|
||||
-zplg-run-task
|
||||
|-- -zplg-load
|
||||
|
|
@ -630,7 +633,7 @@ Has 26 line(s). Calls functions:
|
|||
| `-- zplugin-install.zsh/-zplg-download-snippet
|
||||
`-- zplugin-autoload.zsh/-zplg-unload
|
||||
|
||||
Uses feature(s): _eval_, _source_, _zle_
|
||||
Uses feature(s): _eval_, _source_, _zle_, _zpty_
|
||||
|
||||
Called by:
|
||||
|
||||
|
|
@ -643,7 +646,7 @@ ____
|
|||
# Searches for timeout tasks, executes them
|
||||
____
|
||||
|
||||
Has 27 line(s). *Is a precmd hook*. Calls functions:
|
||||
Has 33 line(s). *Is a precmd hook*. Calls functions:
|
||||
|
||||
-zplg-scheduler
|
||||
|-- -zplg-run-task
|
||||
|
|
@ -673,6 +676,44 @@ Uses feature(s): _sched_
|
|||
|
||||
Not called by script or any function, may be a hook or Zle widget, etc.
|
||||
|
||||
-zplg-service
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
____
|
||||
# Handles given service, i.e. obtains lock, runs it, or waits if no lock
|
||||
#
|
||||
# $1 - type "p" or "s" (plugin or snippet)
|
||||
# $2 - mode - for plugin (light or load)
|
||||
# $3 - id - URL or plugin ID
|
||||
____
|
||||
|
||||
Has 30 line(s). Calls functions:
|
||||
|
||||
-zplg-service
|
||||
|-- -zplg-load
|
||||
| |-- -zplg-any-to-user-plugin
|
||||
| |-- -zplg-load-plugin
|
||||
| | |-- -zplg-add-report
|
||||
| | |-- -zplg-diff-env
|
||||
| | |-- -zplg-diff-functions
|
||||
| | |-- -zplg-diff-options
|
||||
| | |-- -zplg-diff-parameter
|
||||
| | |-- -zplg-find-other-matches
|
||||
| | |-- -zplg-shadow-off
|
||||
| | `-- -zplg-shadow-on
|
||||
| |-- -zplg-pack-ice
|
||||
| |-- -zplg-register-plugin
|
||||
| |-- -zplg-unregister-plugin
|
||||
| | `-- -zplg-any-to-user-plugin
|
||||
| `-- zplugin-install.zsh/-zplg-setup-plugin-dir
|
||||
`-- -zplg-load-snippet
|
||||
|-- -zplg-pack-ice
|
||||
`-- zplugin-install.zsh/-zplg-download-snippet
|
||||
|
||||
Uses feature(s): _kill_, _read_
|
||||
|
||||
Not called by script or any function, may be a hook or Zle widget, etc.
|
||||
|
||||
-zplg-shadow-off
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
|
|
@ -759,7 +800,7 @@ ____
|
|||
# and its arguments, has completion.
|
||||
____
|
||||
|
||||
Has 227 line(s). Calls functions:
|
||||
Has 244 line(s). Calls functions:
|
||||
|
||||
zplugin
|
||||
|-- -zplg-clear-debug-report
|
||||
|
|
@ -800,7 +841,6 @@ Has 227 line(s). Calls functions:
|
|||
|-- -zplg-load-snippet
|
||||
| |-- -zplg-pack-ice
|
||||
| `-- zplugin-install.zsh/-zplg-download-snippet
|
||||
|-- -zplg-prepare-home
|
||||
|-- -zplg-submit-turbo
|
||||
|-- compinit
|
||||
|-- zplugin-autoload.zsh/-zplg-cd
|
||||
|
|
@ -812,6 +852,7 @@ Has 227 line(s). Calls functions:
|
|||
|-- zplugin-autoload.zsh/-zplg-compiled
|
||||
|-- zplugin-autoload.zsh/-zplg-compinit
|
||||
|-- zplugin-autoload.zsh/-zplg-create
|
||||
|-- zplugin-autoload.zsh/-zplg-delete
|
||||
|-- zplugin-autoload.zsh/-zplg-edit
|
||||
|-- zplugin-autoload.zsh/-zplg-glance
|
||||
|-- zplugin-autoload.zsh/-zplg-help
|
||||
|
|
@ -844,7 +885,7 @@ Not called by script or any function, may be a hook or Zle widget, etc.
|
|||
add-zsh-hook
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Has 91 line(s). Doesn't call other functions.
|
||||
Has 93 line(s). Doesn't call other functions.
|
||||
|
||||
Uses feature(s): _autoload_
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue