aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/emit.txt
diff options
context:
space:
mode:
authorGravatar Mark Griffiths <mark@thebespokepixel.com>2014-08-01 03:37:32 +0100
committerGravatar Mark Griffiths <mark@thebespokepixel.com>2014-09-03 14:43:24 +0100
commitd282bc462578a6e47747c78d2d42883530f0d11e (patch)
treea6515e908d4fc1c400cb6cebaf79b1590b005804 /doc_src/emit.txt
parent1c4223889bd729ee83aa21a3450dc28f92ade641 (diff)
Documentation update
Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options.
Diffstat (limited to 'doc_src/emit.txt')
-rw-r--r--doc_src/emit.txt13
1 files changed, 8 insertions, 5 deletions
diff --git a/doc_src/emit.txt b/doc_src/emit.txt
index f00e4233..cfcc107f 100644
--- a/doc_src/emit.txt
+++ b/doc_src/emit.txt
@@ -1,20 +1,23 @@
\section emit emit - Emit a generic event
-\subsection block-synopsis Synopsis
- <tt>emit EVENT_NAME [ARGUMENTS...]</tt>
+\subsection emit-synopsis Synopsis
+\fish{syn}
+emit EVENT_NAME [ARGUMENTS...]
+\endfish
\subsection emit-description Description
-\c emit emits, or fires, an event. Events are delivered to, or caught by, special functions called event handlers. The arguments are passed to the event handlers as function arguments.
+`emit` emits, or fires, an event. Events are delivered to, or caught by, special functions called event handlers. The arguments are passed to the event handlers as function arguments.
\subsection emit-example Example
The following code first defines an event handler for the generic
event named 'test_event', and then emits an event of that type.
-<pre>function event_test --on-event test_event
+\fish
+function event_test --on-event test_event
echo event test: $argv
end
emit test_event something
-</pre>
+\endfish