summaryrefslogtreecommitdiff
path: root/lib/tracer.rb
diff options
context:
space:
mode:
authorzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-02-04 17:59:52 +0000
committerzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-02-04 17:59:52 +0000
commit2a97015041f7276a84eba777da301c926bd9630d (patch)
treeb1e7e4f7e82f1e8dbf750d43f86313f8970fb992 /lib/tracer.rb
parentd06141cde7402ee6003a59a7a47650d3f642f4b0 (diff)
* lib/tracer.rb: Move class overview definition and reformat
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@39044 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/tracer.rb')
-rw-r--r--lib/tracer.rb38
1 files changed, 17 insertions, 21 deletions
diff --git a/lib/tracer.rb b/lib/tracer.rb
index 0ad8ce5..4266abf 100644
--- a/lib/tracer.rb
+++ b/lib/tracer.rb
@@ -1,10 +1,14 @@
+#--
+# $Release Version: 0.3$
+# $Revision: 1.12 $
+require "thread"
+
##
-# = Tracer
+# Outputs a source level execution trace of a Ruby program.
#
-# Tracer outputs a source level execution trace of a Ruby program. It does
-# this by registering an event handler with <code>Kernel#set_trace_func</code>
-# for processing incoming events. It also provides methods for filtering
-# unwanted trace output (see Tracer.add_filter, Tracer.on, and Tracer.off).
+# It does this by registering an event handler with Kernel#set_trace_func for
+# processing incoming events. It also provides methods for filtering unwanted
+# trace output (see Tracer.add_filter, Tracer.on, and Tracer.off).
#
# == Example
#
@@ -42,27 +46,19 @@
#
# Symbol table used for displaying incoming events:
#
-# <tt>}</tt>:: call a C-language routine
-# <tt>{</tt>:: return from a C-language routine
-# <tt>></tt>:: call a Ruby method
-# <tt>C</tt>:: start a class or module definition
-# <tt>E</tt>:: finish a class or module definition
-# <tt>-</tt>:: execute code on a new line
-# <tt>^</tt>:: raise an exception
-# <tt><</tt>:: return from a Ruby method
+# +}+:: call a C-language routine
+# +{+:: return from a C-language routine
+# +>+:: call a Ruby method
+# +C+:: start a class or module definition
+# +E+:: finish a class or module definition
+# +-+:: execute code on a new line
+# +^+:: raise an exception
+# +<+:: return from a Ruby method
#
# == Copyright
#
# by Keiju ISHITSUKA(keiju@ishitsuka.com)
#
-#--
-# $Release Version: 0.3$
-# $Revision: 1.12 $
-require "thread"
-
-#
-# tracer main class
-#
class Tracer
class << self
# display additional debug information (defaults to false)