Comment cleanup for rdoc.

This commit is contained in:
Peter Camilleri 2015-01-30 11:19:00 -05:00
parent a2819624b6
commit 9acca1be31
7 changed files with 14 additions and 11 deletions

View file

@ -4,8 +4,8 @@
# language system.
module XfOOrth
#A class for the management of global, hierarchical, and nested compile
#time contexts.
#A class for the management of global, hierarchical, and nested compile time contexts.
#* compiler/context.rb - \Context constructor, tag support, and local defs.
class Context
#The previous context object that this one builds on. Set to nil if there

View file

@ -3,8 +3,7 @@
#* compiler/context_map_name.rb - The fOOrth language mapping of names in a context.
module XfOOrth
#A class for the management of global, hierarchical, and nested compile
#time contexts.
#* compiler/context_map_name.rb - The fOOrth language mapping of names in a context.
class Context
#Map a name to a specification.

View file

@ -8,3 +8,6 @@ require_relative 'debug/vm_dump'
#Set up the default debug conduit.
$foorth_dbg = $stdout
#* debug.rb - Internal debug support.
module XfOOrth
end

View file

@ -3,7 +3,7 @@
#* debug/context_dump.rb - Debug support for the compiler context.
module XfOOrth
#Debug support for the compiler context.
#* debug/context_dump.rb - Debug support for the compiler context.
class Context
#Dump the context chain to the console for debug.

View file

@ -1,9 +1,9 @@
# coding: utf-8
#* dbg_puts.rb - Display diagnostic/debug information if enabled.
#* debug/dbg_puts.rb - Display diagnostic/debug information if enabled.
module XfOOrth
#* dbg_puts.rb - Display diagnostic/debug information if enabled.
#* debug/dbg_puts.rb - Display diagnostic/debug information if enabled.
class VirtualMachine
#Send out debug info to the fOOrth debug port if debug is enabled.

View file

@ -1,14 +1,15 @@
# coding: utf-8
#* display_abort.rb - Display diagnostic information on an error.
#* debug/display_abort.rb - Display diagnostic information on an error.
module XfOOrth
#* display_abort.rb - Display diagnostic information on an error.
#* debug/display_abort.rb - Display diagnostic information on an error.
class VirtualMachine
#Display the diagnostic data required for a language abort error.
#<br>Parameters:
#* exception - The exception object that required the system abort.
#* exception - The exception object that required the system abort or a
# string describing the error that was encountered.
def display_abort(exception)
puts "\n#{exception}"

View file

@ -3,7 +3,7 @@
#* debug/vm_dump.rb - Debug support for the virtual machine.
module XfOOrth
#Debug support for the virtual machine.
#* debug/vm_dump.rb - Debug support for the virtual machine.
class VirtualMachine
#Dump the virtual machine to the console for debug.