Initial commit

Author: dcodeIO

.gitignore

@@ -0,0 +1 @@
+npm-debug.log

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

NOTICE

@@ -0,0 +1,2 @@
+This software includes (portions of) doco by Daniel 'dcode' Wirtz.
+See: https://github.com/dcodeIO/doco for details

README.md

@@ -0,0 +1,40 @@
+![doco - The JavaScript Documentation Engine](https://raw.github.com/dcodeIO/doco/master/doco.png)
+======================================
+doco aims to become the best tool for documenting JavaScript code, all without the hazzle of other documentation
+engines.
+
+Why?
+----
+As of today, creating documentation of JavaScript code seems to be ugly and error prone. In my opinion that's the reason
+why quick-and-dirty documentation generators like Docco are to popular. Unfortunately, documenting complicated things
+with a tool like Docco ends up in something that actually doesn't document much and is well suited for pretty simple
+and short projects only.
+
+Of course there is JSDoc, which already is a pretty professional approach, but I've made the experience that JSDoc
+is too strict in what it does because it does not just do documenting but also parsing of JavaScript that - in not too
+few cases - goes wrong. Imho writing and putting together documentation should be left to the guy with the gun.
+
+What can doco already do?
+-------------------------
+doco already is able to parse a variety of comment types to a documentation context of well defined objects. This means
+that everything is composed of doco.Context, doco.Declaration, doco.Tag and doco.TypeDef objects which may safely be
+used to generate to-the-point documentation in all different output formats from it.
+
+Additionally, it largely borrows type annotation styles from Closure Compiler. Yes, right, that Java-beast that isn't
+really keeping with the period anymore. However, its type annotation syntax is really useful and able to pinpoint
+pretty much every awkward case. To make this actually work, doco fully understands these cases and is able to untangle
+it entirely.
+
+Plus: It implements node's stream interface for speed.
+
+So, what's next?
+----------------
+I am currently putting together the parts, which are the typedef parser and the different comment types. Later on I am
+going to create generators for markdown, which may be published on GitHub or similar, and HTML for everything else.
+All generators will be plug and play and everyone is invited to create additional generators for stuff like PDF.
+
+Feel free to contact me if you are interested in working on the project!
+
+License
+-------
+Apache License, Version 2.0

bin/doco

@@ -0,0 +1,44 @@
+/**
+ * @license doco (c) 2013 Daniel Wirtz <[email protected]>
+ * Released under the Apache License, Version 2.0
+ * see: http://www.dojojs.org for details
+ */
+module.exports = (function () {
+
+    var util = require("util");
+    
+    /**
+     * doco namespace and convenience parser.
+     * @param {string} source Source to parse
+     * @param {!function(Error, doco.Context=)} callback Callback receiving the parsed and interpreted context
+     */
+    var doco = function(source, callback) {
+        var parser = new doco.Parser();
+        var context = new doco.Context();
+        parser.on("comment", function(comment, decl) {
+            context.interpret(comment, decl);
+        });
+        parser.on("finish", function() {
+            callback(null, context);
+        });
+        parser.write(source);
+        parser.end();
+    };
+
+    /**
+     * Inspects an object including all its private members.
+     * @param {Object} obj Object to inspect
+     * @returns {string} Console friendly result
+     */
+    doco.inspect = function(obj) {
+        return util.inspect(obj, true, null, true);
+    };
+
+    require("./doco/TypeDef.js")(doco);
+    require("./doco/Tag.js")(doco);
+    require("./doco/Declaration.js")(doco);
+    require("./doco/Context.js")(doco);
+    require("./doco/Parser.js")(doco);
+    
+    return doco;
+})();

doco.js

@@ -0,0 +1,59 @@
+module.exports = function(doco) {
+
+    /**
+     * Constructs a new Context.
+     * @constructor
+     */
+    doco.Context = function() {
+
+        /**
+         * Namespace.
+         * @type {!Object.<string,*>}
+         */
+        this.ns = {};
+
+        /**
+         * Context elements.
+         * @type {!Array.<!doco.Context.Element>}
+         */
+        this.elements = [];
+    };
+
+    /**
+     * Interprets a comment / declaration pair.
+     * @param {string} comment Comment
+     * @param {string} declaration Following declaration
+     */
+    doco.Context.prototype.interpret = function(comment, declaration) {
+        // First, get the title out of it
+        var title, tags, decl, match;
+        var p = comment.search(/(?:^|\s)@/); // Skip email addresses
+        if (p > -1) {
+            title = comment.substring(0, p).trim();
+            tags = doco.interpretTags(comment.substring(p).trim());
+        } else {
+            title = comment;
+            tags = [];
+        }
+        decl = doco.interpretDeclaration(declaration);
+        this.elements.push(new doco.Context.Element(title, tags, decl));
+    };
+
+    /**
+     * Constructs a new Context Element.
+     * @param {string} title
+     * @param {!Array.<doco.Tag>} tags
+     * @param {!doco.Declaration} decl
+     * @constructor
+     */
+    doco.Context.Element = function(title, tags, decl) {
+        this.title = title;
+        this.tags = tags;
+        this.decl = decl;
+    };
+    
+    doco.Context.prototype.build = function() {
+        
+    }
+    
+};