var search_data = {"index":{"searchIndex":["deprecatedmethodwarning","deprecatedsignaturewarning","deprecationwarning","dynamic","object","standardwarning","structuredwarnings","classmethods","kernel","test","assertions","warner","warner","test","unit","warning","classmethods","active?()","assert_no_warn()","assert_warn()","backtrace()","disable()","enable()","format()","format()","inspect()","message()","new()","set_backtrace()","to_s()","to_str()","warn()","warned?()","warner()","with_warner()","readme"],"longSearchIndex":["deprecatedmethodwarning","deprecatedsignaturewarning","deprecationwarning","dynamic","object","standardwarning","structuredwarnings","structuredwarnings::classmethods","structuredwarnings::kernel","structuredwarnings::test","structuredwarnings::test::assertions","structuredwarnings::test::warner","structuredwarnings::warner","test","test::unit","warning","warning::classmethods","warning::classmethods#active?()","structuredwarnings::test::assertions#assert_no_warn()","structuredwarnings::test::assertions#assert_warn()","warning#backtrace()","warning::classmethods#disable()","warning::classmethods#enable()","structuredwarnings::test::warner#format()","structuredwarnings::warner#format()","warning#inspect()","warning#message()","warning::new()","warning#set_backtrace()","warning#to_s()","warning#to_str()","structuredwarnings::kernel#warn()","structuredwarnings::test::warner#warned?()","structuredwarnings::classmethods#warner()","structuredwarnings::classmethods#with_warner()",""],"info":[["DeprecatedMethodWarning","","DeprecatedMethodWarning.html","","

This warning marks single methods as deprecated. We recommend to add a\nuseful warning message, which …\n"],["DeprecatedSignatureWarning","","DeprecatedSignatureWarning.html","","

This warning marks the given parameters for a certain methods as\ndeprecated. We recommend to add a useful …\n"],["DeprecationWarning","","DeprecationWarning.html","","

This is a general warning used to mark certain actions as deprecated. We\nrecommend to add a useful warning …\n"],["Dynamic","","Dynamic.html","","

This library was created by Christian Neukirchen in the context of EuRuKo\n2005 and is licensed under …\n"],["Object","","Object.html","",""],["StandardWarning","","StandardWarning.html","","

This warning is used when calling #Kernel.warn without arguments.\n"],["StructuredWarnings","","StructuredWarnings.html","",""],["StructuredWarnings::ClassMethods","","StructuredWarnings/ClassMethods.html","","

If you require "test/unit" after\nstructured_warnings you have to require\n"structured_warnings/test" …\n"],["StructuredWarnings::Kernel","","StructuredWarnings/Kernel.html","","

This module encapsulates the extensions to Object, that are introduced by\nthis library.\n"],["StructuredWarnings::Test","","StructuredWarnings/Test.html","","

This module ecapsulates all extensions to support test/unit.\n"],["StructuredWarnings::Test::Assertions","","StructuredWarnings/Test/Assertions.html","",""],["StructuredWarnings::Test::Warner","","StructuredWarnings/Test/Warner.html","","

This warner is used in Assertions#assert_warn and Assertions#assert_no_warn\nblocks. It captures all warnings …\n"],["StructuredWarnings::Warner","","StructuredWarnings/Warner.html","","

The Warner class implements a very simple interface. It simply formats a\nwarning, so it is more than …\n"],["Test","","Test.html","",""],["Test::Unit","","Test/Unit.html","",""],["Warning","","Warning.html","","

Descendents of class Warning are used to raise structured warnings. They\nprogrammers to explicitly supress …\n"],["Warning::ClassMethods","","Warning/ClassMethods.html","","

This module extends Warning and each subclass. It may be used to activate\nor deactivate a set of warnings. …\n"],["active?","Warning::ClassMethods","Warning/ClassMethods.html#method-i-active-3F","()","

returns a Boolean, stating whether a warning of this type would be emmitted\nor not.\n"],["assert_no_warn","StructuredWarnings::Test::Assertions","StructuredWarnings/Test/Assertions.html#method-i-assert_no_warn","(*args)","

Asserts that the given warning was not emmitted. It may be restricted to a\ncertain subtree of warnings …\n"],["assert_warn","StructuredWarnings::Test::Assertions","StructuredWarnings/Test/Assertions.html#method-i-assert_warn","(*args)","

Asserts that the given warning was emmitted. It may be restricted to a\ncertain subtree of warnings and/or …\n"],["backtrace","Warning","Warning.html#method-i-backtrace","()","

Returns any backtrace associated with the warning. The backtrace is an\narray of strings, each containing …\n"],["disable","Warning::ClassMethods","Warning/ClassMethods.html#method-i-disable","()","

If called without a block, Warnings of this type will be disabled in the\ncurrent thread and all new child …\n"],["enable","Warning::ClassMethods","Warning/ClassMethods.html#method-i-enable","()","

This method has the same semantics as disable, only with the opposite\noutcome. In general the last assignment …\n"],["format","StructuredWarnings::Test::Warner","StructuredWarnings/Test/Warner.html#method-i-format","(warning, message, call_stack)","

Overrides the public interface of StructuredWarnings::Warner. This method\nalways returns nil to avoid …\n"],["format","StructuredWarnings::Warner","StructuredWarnings/Warner.html#method-i-format","(warning, message, stack)","

Warner.new.format(DeprecationWarning, “more info..”, caller)\n\n

# => "demo.rb:5 : more info.. (DeprecationWarning)"\n
\n"],["inspect","Warning","Warning.html#method-i-inspect","()","

Return this warning's class name and message\n"],["message","Warning","Warning.html#method-i-message","()",""],["new","Warning","Warning.html#method-c-new","(message = nil)","

Construct a new Warning object, optionally passing in a message.\n"],["set_backtrace","Warning","Warning.html#method-i-set_backtrace","(backtrace)","

Sets the backtrace information associated with warning. The argument must\nbe an array of String objects …\n"],["to_s","Warning","Warning.html#method-i-to_s","()","

Returns warning's message (or the name of the warning if no message is\nset).\n"],["to_str","Warning","Warning.html#method-i-to_str","()",""],["warn","StructuredWarnings::Kernel","StructuredWarnings/Kernel.html#method-i-warn","(*args)","

This method provides a raise-like interface. It extends the\ndefault warn in ::Kernel to allow the use …\n"],["warned?","StructuredWarnings::Test::Warner","StructuredWarnings/Test/Warner.html#method-i-warned-3F","(warning, message = nil)","

Returns true if any warning or a subclass of warning was emitted.\n"],["warner","StructuredWarnings::ClassMethods","StructuredWarnings/ClassMethods.html#method-i-warner","()","

Gives access to the currently used warner. Default is an instance of\nStructuredWarnings::Warner\n"],["with_warner","StructuredWarnings::ClassMethods","StructuredWarnings/ClassMethods.html#method-i-with_warner","(warner)","

Executes a block using the given warner. This may be used to suppress\nwarnings to stdout, but fetch them …\n"],["README","","README_rdoc.html","","

Structured Warnings\n

This is an implementation of Daniel Berger's proposal of structured\nwarnings for …\n"]]}}