summaryrefslogtreecommitdiff
path: root/docs/api
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
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')
-rw-r--r--docs/api/cmd.rst5
-rw-r--r--docs/api/history.rst3
-rw-r--r--docs/api/index.rst1
-rw-r--r--docs/api/plugin.rst45
4 files changed, 53 insertions, 1 deletions
diff --git a/docs/api/cmd.rst b/docs/api/cmd.rst
index 345e6219..34c0dcf7 100644
--- a/docs/api/cmd.rst
+++ b/docs/api/cmd.rst
@@ -42,3 +42,8 @@ cmd2.Cmd
This attribute is an instance of :class:`cmd2.history.History`, and
each command is an instance of :class:`cmd2.history.HistoryItem`.
+
+ .. attribute:: statement_parser
+
+ An instance of :class:`cmd2.parsing.StatementParser` initialized and
+ configured appropriately for parsing user input.
diff --git a/docs/api/history.rst b/docs/api/history.rst
index a685db7a..3a3ae2c4 100644
--- a/docs/api/history.rst
+++ b/docs/api/history.rst
@@ -4,12 +4,13 @@ cmd2.history
.. autoclass:: cmd2.history.History
:members:
+
.. autoclass:: cmd2.history.HistoryItem
:members:
.. attribute:: statement
- The statement object resulting from parsing
+ The :class:`~cmd2.Statement` object parsed from user input
.. attribute:: idx
diff --git a/docs/api/index.rst b/docs/api/index.rst
index 43b36c7a..4009cd29 100644
--- a/docs/api/index.rst
+++ b/docs/api/index.rst
@@ -10,4 +10,5 @@ API Reference
history
ansi
utils
+ plugin
constants
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