summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/lib/Event.lua
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/lib/Event.lua')
-rw-r--r--Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/lib/Event.lua52
1 files changed, 26 insertions, 26 deletions
diff --git a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/lib/Event.lua b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/lib/Event.lua
index 880796ce973..952f37796eb 100644
--- a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/lib/Event.lua
+++ b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/lib/Event.lua
@@ -19,7 +19,7 @@
-- arcs, and a digraph object representing this graph get
-- constructed. However, even though syntactic annotations such as
-- options for the vertices and arcs are attached to them and can be
--- accessed through the graph objects, some syntactic information is
+-- accessed through the graph objects, some syntactic inforamtion is
-- neither represented in the digraph object nor in the vertices and
-- the arcs. A typical example is a ``missing'' node in a tree: Since
-- it is missing, there is neither a vertex object nor arc objects
@@ -35,37 +35,37 @@
--
-- The following events are created during the parsing process by the
-- standard parsers of \tikzname:
--- %
+--
-- \begin{itemize}
--- \item[|node|] When a node of the input graph has been parsed and
--- a |Vertex| object has been created for it, an event with kind
--- |node| is created. The |parameter| of this event is the
--- just-created vertex.
+-- \item[|node|] When a node of the input graph has been parsed and
+-- a |Vertex| object has been created for it, an event with kind
+-- |node| is created. The |parameter| of this event is the
+-- just-created vertex.
--
--- The same kind of event is used to indicate ``missing'' nodes. In
--- this case, the |parameters| field is |nil|.
--- \item[|edge|] When an edge of the input graph has been parsed, an
--- event is created of kind |edge|. The |parameters| field will store
--- an array with two entries: The first is the |Arc| object whose
--- |syntactic_edges| field stores the |edge|. The second is the index
--- of the edge inside the |syntactic_edges| field.
--- \item[|begin|]
--- Signals the beginning of a group, which will be ended with a
--- corresponding |end| event later on. The |parameters| field will
--- indicate the kind of group. Currently, only the string
--- |"descendants"| is used as |parameters|, indicating the start of
--- several nodes that are descendants of a given node. This
--- information can be used by algorithms for reconstructing the
--- input structure of trees.
--- \item[|end|] Signals the end of a group begun by a |begin| event
--- earlier on.
+-- The same kind of event is used to indicate ``missing'' nodes. In
+-- this case, the |parameters| field is |nil|.
+-- \item[|edge|] When an edge of the input graph has been parsed, an
+-- event is created of kind |edge|. The |parameters| field will store
+-- an array with two entries: The first is the |Arc| object whose
+-- |syntactic_edges| field stores the |edge|. The second is the index
+-- of the edge inside the |syntactic_edges| field.
+-- \item[|begin|]
+-- Signals the beginning of a group, which will be ended with a
+-- corresponding |end| event later on. The |parameters| field will
+-- indicate the kind of group. Currently, only the string
+-- |"descendants"| is used as |parameters|, indicating the start of
+-- several nodes that are descendants of a given node. This
+-- information can be used by algorithms for reconstructing the
+-- input structure of trees.
+-- \item[|end|] Signals the end of a group begun by a |begin| event
+-- earlier on.
-- \end{itemize}
---
--- @field kind A string representing the kind of the events.
+--
+-- @field kind A string representing the kind of the events.
-- @field parameters Kind-specific parameters.
-- @field index A number that stores the events logical position in
-- the sequence of events. The number need not be an integer array
--- index.
+-- index.
--
local Event = {}
Event.__index = Event