RubyGems - distil - Versions diffs - 0.14.4 → 0.14.5.a - Mend

distil 0.14.4 → 0.14.5.a

Files changed (157) hide show

data/vendor/pdoc/website/html/documentation.html DELETED Viewed

@@ -1,280 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"
-   "http://www.w3.org/TR/html4/strict.dtd">
-<html lang="en">
-<head>
-	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-	<title>PDoc</title>
-	<meta name="generator" content="TextMate http://macromates.com/">
-	<meta name="author" content="Tobie Langel">
-	<!-- Date: 2008-02-25 -->
-	<link rel="stylesheet" href="/stylesheets/reset.css" type="text/css" media="screen" charset="utf-8">
-	<link rel="stylesheet" href="/stylesheets/main.css" type="text/css" media="screen" title="no title" charset="utf-8">
-</head>
-<body>
-	<div id="wrapper">
-		<div id="header">
-			<h1><a href="/"><img src="/images/pdoc.jpg" alt="PDoc" /></a></h1>
-		</div>
-		<div id="navigation">
-			<ul>
-				<li><a href="/documentation.html">documentation</a></li>
-				<li><a href="http://github.com/tobie/pdoc/tree/master">source code</a></li>
-				<li><a href="http://prototype.lighthouseapp.com/projects/8889-pdoc/">bug tracker</a></li>
-				<li><a href="http://groups.google.com/group/pdoc">mailing list</a></li>
-			</ul>
-		</div>
-		<div id="content">
-<h1 id="documentation">Documentation</h1>
-<h2 id="comments">Comments</h2>
-<p>Documentation comments start with <code>/**</code> and end with <code>**/</code>. Each new line starts with <code>*</code>. </p>
-<pre><code>/** ...
- *  ...
- **/
-</code></pre>
-<h2 id="tags">Tags</h2>
-<p>The first line of a comment is reserved for tags. Tags are separated by a comma followed by whitespace (&#8220;, &#8220;). They can be either a tag name or a key / value pair separated by a colon and a space (<code>:</code>).</p>
-<p>Currently accepted tags are: <code>deprecated</code>, <code>section:</code>, <code>alias of:</code>, <code>related to:</code></p>
-<pre><code>/** deprecated, section: DOM, alias of: Element#descendantOf
- *  Element#childOf(@element, className) -&gt; Element
- *  ...
- **/
-</code></pre>
-<h2 id="ebnf">EBNF</h2>
-<p>The lines directly following tags are reserved for the EBNF description of the documented object. Typically, there&#8217;s only one EBNF per documented object. However, some objects might require more than one.</p>
-<pre><code>/**
- *  Element#down(@element[, cssSelector][, index]) -&gt; Element | null
- *  ...
- **/
-/**
- *  Element#writeAttribute(@element, attribute[, value = true]) -&gt; Element
- *  Element#writeAttribute(@element, attributes) -&gt; Element
- *  ...
- **/
-</code></pre>
-<h3 id="arguments">Arguments</h3>
-<p>For all methods, functions, etc. parentheses around the arguments are required even if no arguments are present.
-The syntax for arguments is as follows:</p>
-<h4 id="required_arguments">required arguments</h4>
-<pre><code>/**
- *  Event.stop(event) -&gt; Event
- *  ...
- **/
-</code></pre>
-<h4 id="optional_arguments">optional arguments</h4>
-<p>Optional arguments are surrounded by squared brackets (<code>[]</code>).</p>
-<pre><code>/**
- *  String#evalJSON([sanitize]) -&gt; Object | Array
- *  ...
- **/
-</code></pre>
-<p>A default value may be indicated using the equal sign (<code>=</code>).</p>
-<pre><code>/**
- *  String#evalJSON([sanitize = false]) -&gt; Object | Array
- *  ...
- **/
-</code></pre>
-<p>Note that the argument separating comas belong <em>inside</em> the brackets.</p>
-<pre><code>/**
- *  Event.findElement(event[, cssSelector]) -&gt; Element | null
- *  ...
- **/
-</code></pre>
-<p>Arguments can be described below the EBNF description using the following syntax:</p>
-<pre><code>- argumentName (acceptedTypes...): description.
-</code></pre>
-<p>For example (notice the 4 space indent in the last line): </p>
-<pre><code>/**
- *  Event.findElement(event[, cssSelector]) -&gt; Element | null
- *  - event (Event): a native Event instance
- *  - cssSelector (String): a optional CSS selector which uses
- *      the same syntax found in regular CSS.
- **/
-</code></pre>
-<h3 id="supported_ebnf_types">Supported EBNF types</h3>
-<h4 id="namespace">Namespace</h4>
-<pre><code>/**
- *  Ajax
- *  ...
- **/
-/**
- *  Prototype.Browser
- *  ...
- **/
-</code></pre>
-<h4 id="classes">Classes</h4>
-<p>Classes require a <code>class</code> prefix:</p>
-<pre><code>/**
- *  class Ajax.Base
- *  ...
- **/
-</code></pre>
-<p>Sub-classes can indicate their parent just like in the Ruby syntax:</p>
-<pre><code>/**
- *  class Ajax.Request &lt; Ajax.Base
- *  ...
- **/
-</code></pre>
-<p>Where <code>Ajax.Base</code> is the parent class and <code>Ajax.Request</code> the subclass.</p>
-<p>Included mixins are indicated like so:</p>
-<pre><code>/**
- *  class CustomHash
- *  includes Enumerable, Comparable
- **/
-</code></pre>
-<h4 id="mixins">Mixins</h4>
-<p>Mixins are indicated by a <code>mixin</code> prefix:</p>
-<pre><code>/**
- *  mixin Enumerable
- *  ...
- **/
-</code></pre>
-<h4 id="constructors">Constructors</h4>
-<p>Constructors require the <code>new</code> prefix and their arguments.</p>
-<pre><code>/**
- *  new Element(tagName[, attributes])
- *  ...
- **/
-/**
- *  new Foobar()
- *  ...
- **/
-</code></pre>
-<h4 id="klass_methods">Klass Methods</h4>
-<p>Klass methods are identified by a dot (<code>.</code>).</p>
-<pre><code>/**
- *  Array.from([iterable]) -&gt; Array
- *  ...
- **/
-</code></pre>
-<h4 id="instance_methods">Instance Methods</h4>
-<p>Instance methods are identified by the hash symbol (<code>#</code>).</p>
-<pre><code>/**
- *  Array#first() -&gt; Array element
- *  ...
- **/
-</code></pre>
-<h4 id="utilities">Utilities</h4>
-<p>Utilities are global functions starting with a dollar-sign (<code>$</code>).</p>
-<pre><code>/**
- *  $w(string) -&gt; Array
- *  ...
- **/
-</code></pre>
-<h4 id="methodized_methods">Methodized Methods</h4>
-<p>Methodized methods are methods which are both available as a class method and an instance method, in which case the first argument becomes the instance object itself. For example, all of <code>Element</code>&#8217;s instance methods are methodized and thus also available as class methods of <code>Element</code>. Methodized methods are indicated by prefixing their first argument with the <code>@</code> symbol.</p>
-<pre><code>/**
- *  Element#hide(@element) -&gt; Element
- *  ...
- **/
-</code></pre>
-<h4 id="klass_properties">Klass Properties</h4>
-<p>Klass properties are identified by a dot (<code>.</code>).</p>
-<pre><code>/**
- *  Ajax.Responders.responders -&gt; Array
- *  ...
- **/
-</code></pre>
-<h4 id="instance_properties">Instance Properties</h4>
-<p>Instance properties are identified by the hash symbol (<code>#</code>).</p>
-<pre><code>/**
- *  Ajax.Response#responseText -&gt; String
- *  ...
- **/
-</code></pre>
-<h4 id="constants">Constants</h4>
-<p>Constant must have their value specified using the equal sign (<code>=</code>).</p>
-<pre><code>/**
- *  Prototype.JSONFilter = /^\/\*-secure-([\s\S]*)\*\/\s*$/
- *  ...
- **/
-</code></pre>
-<h3 id="events">Events</h3>
-<p>Some methods can fire native or custom events. These are indicated below the arguments descriptions:</p>
-<pre><code>/**
- *  Ajax.Request#respondToReadyState(readyState) -&gt; undefined
- *  - readyState (Number): a number from 0 to 4 corresponding to the state of the request.
- *  fires ajax:created, ajax:completed
- **/
-</code></pre>
-		</div>
-		<div id="sidebar">
-		</div>
-		<div id="footer">
-			<p>&copy; 2008 Tobie Langel. PDoc logo &copy; 2008 Sam Stephenson.</p>
-		</div>
-	</div>
-</body>
-</html>

data/vendor/pdoc/website/html/images/pdoc.jpg DELETED Viewed

Binary file

data/vendor/pdoc/website/html/index.html DELETED Viewed

@@ -1,84 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"
-   "http://www.w3.org/TR/html4/strict.dtd">
-<html lang="en">
-<head>
-	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-	<title>PDoc</title>
-	<meta name="generator" content="TextMate http://macromates.com/">
-	<meta name="author" content="Tobie Langel">
-	<!-- Date: 2008-02-25 -->
-	<link rel="stylesheet" href="/stylesheets/reset.css" type="text/css" media="screen" charset="utf-8">
-	<link rel="stylesheet" href="/stylesheets/main.css" type="text/css" media="screen" title="no title" charset="utf-8">
-</head>
-<body>
-	<div id="wrapper">
-		<div id="header">
-			<h1><a href="/"><img src="/images/pdoc.jpg" alt="PDoc" /></a></h1>
-		</div>
-		<div id="navigation">
-			<ul>
-				<li><a href="/documentation.html">documentation</a></li>
-				<li><a href="http://github.com/tobie/pdoc/tree/master">source code</a></li>
-				<li><a href="/doc/index.html">rdoc</a></li>
-				<li><a href="http://prototype.lighthouseapp.com/projects/8889-pdoc/">bug tracker</a></li>
-				<li><a href="http://groups.google.com/group/pdoc">mailing list</a></li>
-			</ul>
-		</div>
-		<div id="content">
-			<h1>PDoc</h1>
-			<p>PDoc is an inline comment parser and JavaScript documentation generator written in Ruby. It is designed for documenting <a href="http://prototypejs.org">Prototype</a> and Prototype-based libraries.</p>
-			<p>PDoc uses <a href="http://treetop.rubyforge.org/">Treetop</a>, a Ruby-based DSL for text parsing and interpretation, and its own ActionView-inspired, ERB-based templating system for HTML generation. Other documentation generators (e.g., DocBook XML) are planned.</p>
-			<p>Unlike other inline-doc parsers, PDoc does not rely on the JavaScript source code at all; it only parses the comments. This approach, though slightly more verbose, is much better at generating consistent, reliable documentation, and avoids the headaches encountered when documenting highly dynamic languages.</p>
-			<h2>Installation</h2>
-			<p>PDoc depends on Rake, <a href="http://maruku.rubyforge.org/">Maruku</a>, and treetop, all of which can be obtained through RubyGems:</p>
-			<pre><code>gem install rake maruku treetop
-			</code></pre>
-			<p>Maruku is a more solid alternative to BlueCloth and is compatible with Ruby 1.9.1.</p>
-			<h2>Usage</h2>
-			<p>For hints on how to run PDoc on the command line, consult the built-in Rake tasks (in <code>Rakefile</code>) and the <code>PDoc::Runner</code> class (in <code>lib/pdoc/runner.rb</code>).</p>
-			<h2>How it works</h2>
-			<p>The process of turning inline PDoc comments into a human-friendly document has two phases.</p>
-			<h3>Parsing phase</h3>
-			<p>In this phase, the source files are scanned for PDoc comments, then parsed with the Ruby files generated from the Treetop language grammar. The product of this phase is a tree full of specialized classes, all of which inherit from <code>Treetop::Runtime::SyntaxNode</code>.</p>
-			<p>The root of the tree is an instance of <code>Documentation::Doc</code>. It comprises one or more instances of <code>Documentation::Section</code>; which in turn comprise language elements like namespaces, classes, constants, etc., all of which have class representations.</p>
-			<h3>Rendering phase</h3>
-			<p>Next, PDoc asks a <em>generator</em> how to translate this abstract tree into a hierarchical document. The default generator outputs organized HTML in a manner similar to <a href="http://rdoc.sourceforge.net/" title="RDoc - Document Generator for Ruby Source">RDoc</a>&#8217;s.</p>
-			<p>The HTML generator (<code>PDoc::Generators::Html</code>) has associated <em>templates</em> (in the <code>templates</code> directory) that accept syntax nodes and echo their metadata onto the page using <a href="http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/index.html" title="erb: Ruby Standard Library Documentation">ERB</a>. Templates are modular, so it&#8217;s quite easy to apply a custom &#8220;skin&#8221; to one&#8217;s documentation pages.</p>
-			<p>Furthermore, generators themselves are modular; PDoc can, theoretically, parse once and render to several different targets (HTML, <a href="http://www.docbook.org/" title="DocBook.org">DocBook XML</a>, CHM, PDF, even <a href="http://www.scriptdoc.org/" title="ScriptDoc.org: Dynamic Language Documentation">ScriptDoc</a>.) We hope many such generators will exist in the future.</p>
-			<div id="twitter_div">
-				<h2 class="twitter-title">Twitter Updates</h2>
-				<ul id="twitter_update_list"></ul>
-			</div>
-		</div>
-		<div id="sidebar">
-		</div>
-		<div id="footer">
-			<p>&copy; 2008 Tobie Langel. PDoc logo &copy; 2008 Sam Stephenson.</p>
-		</div>
-	</div>
-	<script type="text/javascript" src="http://twitter.com/javascripts/blogger.js"></script>
-	<script type="text/javascript" src="http://twitter.com/statuses/user_timeline/pdoc.json?callback=twitterCallback2&count=5"></script>
-</body>
-</html>

data/vendor/pdoc/website/html/stylesheets/main.css DELETED Viewed

@@ -1,73 +0,0 @@
-body {
-	font-family: Helvetica, Arial, sans-serif;
-}
-#wrapper {
-	width: 800px;
-	margin: 30px auto;
-}
-#header {
-	margin-bottom: 30px;
-}
-#navigation {
-	float: left;
-	width: 100%;
-	line-height: normal;
-	height: 30px;
-}
-#navigation ul li {
-	float: left;
-}
-#navigation ul li.selected {
-}
-#navigation ul li a {
-	color: #666;
-	margin-right: 10px;
-	text-decoration: none;
-	border-bottom: 1px solid #999;
-}
-#navigation ul li a:hover {
-	color: #000;
-	border-bottom: 1px solid #333;
-	text-decoration: none;
-}
-#content h1,
-#content h4,
-#content h3,
-#content h4 {
-	font-weight: bold;
-	margin-bottom: 15px;
-}
-#content h1 {
-	font-size: 2em;
-}
-#content h2 {
-	font-size: 1.6em;
-}
-#content h3 {
-	font-size: 1.2em;
-}
-#content h4 {
-	font-size: 1em;
-}
-#content p {
-	margin-bottom: 1em;
-}
-#content pre {
-	margin-bottom: 1em;
-	padding: 1em;
-	background-color: #eee;
-}

data/vendor/pdoc/website/html/stylesheets/reset.css DELETED Viewed

@@ -1,18 +0,0 @@
-/*
-Copyright (c) 2007, Yahoo! Inc. All rights reserved.
-Code licensed under the BSD License:
-http://developer.yahoo.net/yui/license.txt
-version: 2.4.1
-*/
-body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,textarea,p,blockquote,th,td{margin:0;padding:0;}
-table{border-collapse:collapse;border-spacing:0;}
-fieldset,img{border:0;}
-address,caption,cite,code,dfn,em,strong,th,var{font-style:normal;font-weight:normal;}
-li{list-style:none;}
-caption,th{text-align:left;}
-h1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}
-q:before,q:after{content:'';}
-abbr,acronym {border:0;font-variant:normal;}
-/* to preserve line-height and selector appearance */
-sup {vertical-align:text-top;}
-sub {vertical-align:text-bottom;}