Scribd Logo
Upload

Welcome to Scribd!

  • Notes Ak

    Uploaded by

    aamir khan
    13 views4 pages
    This document provides documentation on the modules that make up a command line interface and web service for lipsum.org. It describes 5 modules: cli.coffee, lipsum.coffee, parser.coffee, service.coffee. For each it provides the module name, purpose, and any classes or functions within.

    Original Description:

    Original Title

    notes ak

    Copyright

    © © All Rights Reserved

    Available Formats

    DOC, PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    Report this Document
    This document provides documentation on the modules that make up a command line interface and web service for lipsum.org. It describes 5 modules: cli.coffee, lipsum.coffee, parser.coffee, service.coffee. For each it provides the module name, purpose, and any classes or functions within.

    Copyright:

    © All Rights Reserved
    Download as DOC, PDF, TXT or read online from Scribd
    Flag for inappropriate content
    13 views4 pages

    Notes Ak

    Uploaded by

    aamir khan
    This document provides documentation on the modules that make up a command line interface and web service for lipsum.org. It describes 5 modules: cli.coffee, lipsum.coffee, parser.coffee, service.coffee. For each it provides the module name, purpose, and any classes or functions within.

    Copyright:

    © All Rights Reserved
    Download as DOC, PDF, TXT or read online from Scribd
    Flag for inappropriate content
    of 4

    <html>

    <head>
    <title>CoffeeDoc</title>
    <meta http-equiv="content-type" content="text/html; charset=UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <link rel="stylesheet" media="all" href="resources/base.css" />
    </head>
    <body>
    <div class="container">
    <div class="sidebar column">

    <li><a href="src/parser.coffee.html">src/parser.coffee</a></li>

    <li><a href="src/service.coffee.html">src/service.coffee</a></li>

    </ul>
    </div>
    <div class="content column">

    <div class="module">
    <div class="header">
    <a href="src/cli.coffee.html"><h1>cli.coffee</h1></a>
    </div>
    <div class="module-content">
    <h1>Lipsum Command-line Interface</h1>
    <p>This module provides a CLI wrapper for the main module, allowing it to b
    easily used via anyone&#39;s login shell.
    </p>
    <h3>Functions</h3>
    <ul class="functionlist">

    <li><a href="src/cli.coffee.html#exports.run">exports.run(args)</a></li>

    <li><a href="src/cli.coffee.html#exports._run">exports._run(argv)</a></li>

    </ul>

    </div>
    </div>

    <div class="module">
    <div class="header">
    <a href="src/lipsum.coffee.html"><h1>lipsum.coffee</h1></a>
    </div>
    <div class="module-content">
    <h1>Lorem Ipsum Wrapper</h1>

    <h3>Classes</h3>
    <ul class="classlist">

    </ul>

    </div>
    </div>

    <div class="module">
    <div class="header">
    <a href="src/parser.coffee.html"><h1>parser.coffee</h1></a>
    </div>
    <div class="module-content">
    <h1>Lipsum Parser</h1>
    <p>Detects whether input is XML or JSON and parses accordingly.
    Parsing within the file provides the advantage of decoupling server calls w
    calls to the parser, as it is able to be agnostic to the format received. I
    cannot, however, parse HTML (nor should it have to).
    </p>

    <h3>Classes</h3>
    <ul class="classlist">

    <li><a href="src/parser.coffee.html#LipsumParser">LipsumParser</a></li>

    </ul>

    </div>
    </div>

    <div class="module">
    <div class="header">
    <a href="src/service.coffee.html"><h1>service.coffee</h1></a>
    </div>
    <div class="module-content">
    <h1>Web Service for lipsum.org</h1>
    <p>Provides the low-level interface to the lipsum.org
    service.
    </p>

    <h3>Classes</h3>
    <ul class="classlist">

    <li><a href="src/service.coffee.html#Service">Service</a></li>

    </ul>

    </div>
    </div>

    </div>
    </div>
    </body>
    </html>

    You might also like