diff options
| author | Florian Frank <flori@ping.de> | 2010-03-13 21:30:07 +0100 |
|---|---|---|
| committer | Florian Frank <flori@ping.de> | 2010-03-13 21:30:07 +0100 |
| commit | d8afab19b2fa7617e6ea59dd4be9cfdc6e8f3813 (patch) | |
| tree | a59d2c42438a65c9cef8f99708310c1cec9aa45f /doc/Kernel.html | |
| parent | 596acf2b3ed959ec023eead5116ea89b94a4b65d (diff) | |
| download | json-d8afab19b2fa7617e6ea59dd4be9cfdc6e8f3813.tar.gz | |
generated documentation
Diffstat (limited to 'doc/Kernel.html')
| -rw-r--r-- | doc/Kernel.html | 383 |
1 files changed, 383 insertions, 0 deletions
diff --git a/doc/Kernel.html b/doc/Kernel.html new file mode 100644 index 0000000..8fd1a6d --- /dev/null +++ b/doc/Kernel.html @@ -0,0 +1,383 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <meta content="text/html; charset=utf-8" http-equiv="Content-Type" /> + + <title>Module: Kernel</title> + + <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" /> + + <script src="./js/jquery.js" type="text/javascript" + charset="utf-8"></script> + <script src="./js/thickbox-compressed.js" type="text/javascript" + charset="utf-8"></script> + <script src="./js/quicksearch.js" type="text/javascript" + charset="utf-8"></script> + <script src="./js/darkfish.js" type="text/javascript" + charset="utf-8"></script> + +</head> +<body class="module"> + + <div id="metadata"> + <div id="file-metadata"> + <div id="file-list-section" class="section"> + <h3 class="section-header">In Files</h3> + <div class="section-body"> + <ul> + + <li><a href="./lib/json/common_rb.html?TB_iframe=true&height=550&width=785" + class="thickbox" title="lib/json/common.rb">lib/json/common.rb</a></li> + + </ul> + </div> + </div> + + + </div> + + <div id="class-metadata"> + + <!-- Parent Class --> + + + <!-- Namespace Contents --> + + + <!-- Method Quickref --> + + <div id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + <ul class="link-list"> + + <li><a href="#M000038">#JSON</a></li> + + <li><a href="#M000036">#j</a></li> + + <li><a href="#M000037">#jj</a></li> + + </ul> + </div> + + + <!-- Included Modules --> + + </div> + + <div id="project-metadata"> + + + <div id="fileindex-section" class="section project-section"> + <h3 class="section-header">Files</h3> + <ul> + + <li class="file"><a href="./README.html">README</a></li> + + </ul> + </div> + + + <div id="classindex-section" class="section project-section"> + <h3 class="section-header">Class Index + <span class="search-toggle"><img src="./images/find.png" + height="16" width="16" alt="[+]" + title="show/hide quicksearch" /></span></h3> + <form action="#" method="get" accept-charset="utf-8" class="initially-hidden"> + <fieldset> + <legend>Quicksearch</legend> + <input type="text" name="quicksearch" value="" + class="quicksearch-field" /> + </fieldset> + </form> + + <ul class="link-list"> + + <li><a href="./JSON.html">JSON</a></li> + + <li><a href="./JSON/CircularDatastructure.html">JSON::CircularDatastructure</a></li> + + <li><a href="./JSON/Editor.html">JSON::Editor</a></li> + + <li><a href="./JSON/Editor/EditMenu.html">JSON::Editor::EditMenu</a></li> + + <li><a href="./JSON/Editor/FileMenu.html">JSON::Editor::FileMenu</a></li> + + <li><a href="./JSON/Editor/Gtk.html">JSON::Editor::Gtk</a></li> + + <li><a href="./JSON/Editor/Gtk/TreeIter.html">JSON::Editor::Gtk::TreeIter</a></li> + + <li><a href="./JSON/Editor/JSONTreeView.html">JSON::Editor::JSONTreeView</a></li> + + <li><a href="./JSON/Editor/MainWindow.html">JSON::Editor::MainWindow</a></li> + + <li><a href="./JSON/Editor/MenuExtension.html">JSON::Editor::MenuExtension</a></li> + + <li><a href="./JSON/Editor/OptionsMenu.html">JSON::Editor::OptionsMenu</a></li> + + <li><a href="./JSON/Editor/PopUpMenu.html">JSON::Editor::PopUpMenu</a></li> + + <li><a href="./JSON/Ext.html">JSON::Ext</a></li> + + <li><a href="./JSON/Ext/Generator.html">JSON::Ext::Generator</a></li> + + <li><a href="./JSON/Ext/Generator/GeneratorMethods.html">JSON::Ext::Generator::GeneratorMethods</a></li> + + <li><a href="./JSON/Ext/Generator/GeneratorMethods/Array.html">JSON::Ext::Generator::GeneratorMethods::Array</a></li> + + <li><a href="./JSON/Ext/Generator/GeneratorMethods/FalseClass.html">JSON::Ext::Generator::GeneratorMethods::FalseClass</a></li> + + <li><a href="./JSON/Ext/Generator/GeneratorMethods/Float.html">JSON::Ext::Generator::GeneratorMethods::Float</a></li> + + <li><a href="./JSON/Ext/Generator/GeneratorMethods/Hash.html">JSON::Ext::Generator::GeneratorMethods::Hash</a></li> + + <li><a href="./JSON/Ext/Generator/GeneratorMethods/Integer.html">JSON::Ext::Generator::GeneratorMethods::Integer</a></li> + + <li><a href="./JSON/Ext/Generator/GeneratorMethods/NilClass.html">JSON::Ext::Generator::GeneratorMethods::NilClass</a></li> + + <li><a href="./JSON/Ext/Generator/GeneratorMethods/Object.html">JSON::Ext::Generator::GeneratorMethods::Object</a></li> + + <li><a href="./JSON/Ext/Generator/GeneratorMethods/String.html">JSON::Ext::Generator::GeneratorMethods::String</a></li> + + <li><a href="./JSON/Ext/Generator/GeneratorMethods/String/Extend.html">JSON::Ext::Generator::GeneratorMethods::String::Extend</a></li> + + <li><a href="./JSON/Ext/Generator/GeneratorMethods/TrueClass.html">JSON::Ext::Generator::GeneratorMethods::TrueClass</a></li> + + <li><a href="./JSON/Ext/Generator/State.html">JSON::Ext::Generator::State</a></li> + + <li><a href="./JSON/Ext/Parser.html">JSON::Ext::Parser</a></li> + + <li><a href="./JSON/GeneratorError.html">JSON::GeneratorError</a></li> + + <li><a href="./JSON/JSONError.html">JSON::JSONError</a></li> + + <li><a href="./JSON/MissingUnicodeSupport.html">JSON::MissingUnicodeSupport</a></li> + + <li><a href="./JSON/NestingError.html">JSON::NestingError</a></li> + + <li><a href="./JSON/ParserError.html">JSON::ParserError</a></li> + + <li><a href="./JSON/Pure.html">JSON::Pure</a></li> + + <li><a href="./JSON/Pure/Generator.html">JSON::Pure::Generator</a></li> + + <li><a href="./JSON/Pure/Generator/GeneratorMethods.html">JSON::Pure::Generator::GeneratorMethods</a></li> + + <li><a href="./JSON/Pure/Generator/GeneratorMethods/Array.html">JSON::Pure::Generator::GeneratorMethods::Array</a></li> + + <li><a href="./JSON/Pure/Generator/GeneratorMethods/FalseClass.html">JSON::Pure::Generator::GeneratorMethods::FalseClass</a></li> + + <li><a href="./JSON/Pure/Generator/GeneratorMethods/Float.html">JSON::Pure::Generator::GeneratorMethods::Float</a></li> + + <li><a href="./JSON/Pure/Generator/GeneratorMethods/Hash.html">JSON::Pure::Generator::GeneratorMethods::Hash</a></li> + + <li><a href="./JSON/Pure/Generator/GeneratorMethods/Integer.html">JSON::Pure::Generator::GeneratorMethods::Integer</a></li> + + <li><a href="./JSON/Pure/Generator/GeneratorMethods/NilClass.html">JSON::Pure::Generator::GeneratorMethods::NilClass</a></li> + + <li><a href="./JSON/Pure/Generator/GeneratorMethods/Object.html">JSON::Pure::Generator::GeneratorMethods::Object</a></li> + + <li><a href="./JSON/Pure/Generator/GeneratorMethods/String.html">JSON::Pure::Generator::GeneratorMethods::String</a></li> + + <li><a href="./JSON/Pure/Generator/GeneratorMethods/String/Extend.html">JSON::Pure::Generator::GeneratorMethods::String::Extend</a></li> + + <li><a href="./JSON/Pure/Generator/GeneratorMethods/TrueClass.html">JSON::Pure::Generator::GeneratorMethods::TrueClass</a></li> + + <li><a href="./JSON/Pure/Generator/State.html">JSON::Pure::Generator::State</a></li> + + <li><a href="./JSON/Pure/Parser.html">JSON::Pure::Parser</a></li> + + <li><a href="./Class.html">Class</a></li> + + <li><a href="./Date.html">Date</a></li> + + <li><a href="./DateTime.html">DateTime</a></li> + + <li><a href="./Enumerable.html">Enumerable</a></li> + + <li><a href="./Exception.html">Exception</a></li> + + <li><a href="./Kernel.html">Kernel</a></li> + + <li><a href="./Object.html">Object</a></li> + + <li><a href="./Range.html">Range</a></li> + + <li><a href="./Regexp.html">Regexp</a></li> + + <li><a href="./Struct.html">Struct</a></li> + + <li><a href="./Symbol.html">Symbol</a></li> + + <li><a href="./Time.html">Time</a></li> + + </ul> + <div id="no-class-search-results" style="display: none;">No matching classes.</div> + </div> + + + </div> + </div> + + <div id="documentation"> + <h1 class="module">Kernel</h1> + + <div id="description"> + + </div> + + <!-- Constants --> + + + <!-- Attributes --> + + + <!-- Methods --> + + <div id="private-instance-method-details" class="method-section section"> + <h3 class="section-header">Private Instance Methods</h3> + + + <div id="--method" class="method-detail "> + <a name="M000038"></a> + + <div class="method-heading"> + + <span class="method-name">JSON</span><span + class="method-args">(object, opts = {})</span> + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-description"> + + <p> +If <em>object</em> is string-like parse the string and return the parsed +result as a Ruby data structure. Otherwise generate a <a +href="Kernel.html#M000038">JSON</a> text from the Ruby data structure +object and return it. +</p> +<p> +The <em>opts</em> argument is passed through to generate/parse +respectively, see generate and parse for their documentation. +</p> + + + + <div class="method-source-code" + id="--source"> +<pre> +<span class="ruby-comment cmt"># File lib/json/common.rb, line 359</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-constant">JSON</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">opts</span> = {}) + <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">object</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-identifier">:to_str</span> + <span class="ruby-constant">JSON</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">object</span>.<span class="ruby-identifier">to_str</span>, <span class="ruby-identifier">opts</span>) + <span class="ruby-keyword kw">else</span> + <span class="ruby-constant">JSON</span>.<span class="ruby-identifier">generate</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">opts</span>) + <span class="ruby-keyword kw">end</span> + <span class="ruby-keyword kw">end</span></pre> + </div> + + </div> + + + </div> + + + <div id="j-method" class="method-detail "> + <a name="M000036"></a> + + <div class="method-heading"> + + <span class="method-name">j</span><span + class="method-args">(*objs)</span> + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-description"> + + <p> +Outputs <em>objs</em> to STDOUT as <a href="Kernel.html#M000038">JSON</a> +strings in the shortest form, that is in one line. +</p> + + + + <div class="method-source-code" + id="j-source"> +<pre> +<span class="ruby-comment cmt"># File lib/json/common.rb, line 337</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">j</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">objs</span>) + <span class="ruby-identifier">objs</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">obj</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">puts</span> <span class="ruby-constant">JSON</span><span class="ruby-operator">::</span><span class="ruby-identifier">generate</span>(<span class="ruby-identifier">obj</span>, <span class="ruby-identifier">:allow_nan</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>, <span class="ruby-identifier">:max_nesting</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>) + <span class="ruby-keyword kw">end</span> + <span class="ruby-keyword kw">nil</span> + <span class="ruby-keyword kw">end</span></pre> + </div> + + </div> + + + </div> + + + <div id="jj-method" class="method-detail "> + <a name="M000037"></a> + + <div class="method-heading"> + + <span class="method-name">jj</span><span + class="method-args">(*objs)</span> + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-description"> + + <p> +Ouputs <em>objs</em> to STDOUT as <a href="Kernel.html#M000038">JSON</a> +strings in a pretty format, with indentation and over many lines. +</p> + + + + <div class="method-source-code" + id="jj-source"> +<pre> +<span class="ruby-comment cmt"># File lib/json/common.rb, line 346</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jj</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">objs</span>) + <span class="ruby-identifier">objs</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">obj</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">puts</span> <span class="ruby-constant">JSON</span><span class="ruby-operator">::</span><span class="ruby-identifier">pretty_generate</span>(<span class="ruby-identifier">obj</span>, <span class="ruby-identifier">:allow_nan</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>, <span class="ruby-identifier">:max_nesting</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>) + <span class="ruby-keyword kw">end</span> + <span class="ruby-keyword kw">nil</span> + <span class="ruby-keyword kw">end</span></pre> + </div> + + </div> + + + </div> + + + </div> + + + </div> + + + <div id="rdoc-debugging-section-dump" class="debugging-section"> + + <p>Disabled; run with --debug to generate this.</p> + + </div> + + <div id="validator-badges"> + <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> + <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish + Rdoc Generator</a> 1.1.6</small>.</p> + </div> + +</body> +</html> + |