summaryrefslogtreecommitdiff
path: root/docs/api/plugin.rst
diff options
context:
space:
mode:
authorkotfu <kotfu@kotfu.net>2020-02-20 22:38:23 -0700
committerkotfu <kotfu@kotfu.net>2020-02-20 22:38:23 -0700
commitc91fd00368aa6d699ce3f3019562664f340543d1 (patch)
treeeba2b5d5af5d5c91c43657ab5c53b3ae8a201f1d /docs/api/plugin.rst
parent36465ad953ac550626d219bb08c7ef214eaaede0 (diff)
downloadcmd2-git-c91fd00368aa6d699ce3f3019562664f340543d1.tar.gz
plugin and hook documentation updates
- add api documentation for plugin data classes - update hook and plugin documentation to link to now documented api classes
Diffstat (limited to 'docs/api/plugin.rst')
-rw-r--r--docs/api/plugin.rst45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/api/plugin.rst b/docs/api/plugin.rst
new file mode 100644
index 00000000..4e554b33
--- /dev/null
+++ b/docs/api/plugin.rst
@@ -0,0 +1,45 @@
+cmd2.plugin
+===========
+
+.. autoclass:: cmd2.plugin.PostparsingData
+ :members:
+
+ .. attribute:: stop
+
+ Request the command loop terminate by setting ``True``
+
+ .. attribute:: statement
+
+ The :class:`~cmd2.Statement` object parsed from user input
+
+
+.. autoclass:: cmd2.plugin.PrecommandData
+ :members:
+
+ .. attribute:: statement
+
+ The :class:`~cmd2.Statement` object parsed from user input
+
+
+.. autoclass:: cmd2.plugin.PostcommandData
+ :members:
+
+ .. attribute:: stop
+
+ Request the command loop terminate by setting ``True``
+
+ .. attribute:: statement
+
+ The :class:`~cmd2.Statement` object parsed from user input
+
+
+.. autoclass:: cmd2.plugin.CommandFinalizationData
+ :members:
+
+ .. attribute:: stop
+
+ Request the command loop terminate by setting ``True``
+
+ .. attribute:: statement
+
+ The :class:`~cmd2.Statement` object parsed from user input