sc-docs 0.0.1

data/vendor/jsdoc/app/test/shared2.js

@@ -0,0 +1,2 @@
+startOver = function(){
+}

data/vendor/jsdoc/app/test/shortcuts.js

@@ -0,0 +1,22 @@
+// /**#=+
+//  * {
+//  *	'D': 'Date.prototype',
+//  *	'$N': 'Number'
+//  * }
+//  */
+// var D = Date.prototype,
+// $N = Number;
+// 
+// D.locale = function(){
+// };
+// 
+// /**
+// 	@return {string} The cardinal number string.
+// */
+// $N.nth = function(n){
+// };
+// 
+// LOAD.file = function(){
+// }
+// 
+// /**#=-*/

data/vendor/jsdoc/app/test/static_this.js

@@ -0,0 +1,13 @@
+/** the parent */
+var box = {};
+
+/** @namespace */
+box.holder = {}
+
+box.holder.foo = function() {
+	/** the counter */
+	this.counter = 1;
+}
+
+box.holder.foo();
+print(box.holder.counter);

data/vendor/jsdoc/app/test/synonyms.js

@@ -0,0 +1,31 @@
+/**
+	@class
+	@inherits Bar#zop as #my_zop
+*/
+function Foo() {
+	/** this is a zip. */
+	this.zip = function() {}
+	
+	/** from Bar */
+	this.my_zop = new Bar().zop;
+}
+
+/**
+	@class
+	@borrows Foo#zip as this.my_zip
+*/
+function Bar() {
+	/** this is a zop. */
+	this.zop = function() {}
+	
+	/** from Foo */
+	this.my_zip = new Foo().zip;
+}
+
+/** @namespace */
+var myObject = {
+	/**
+		@type function
+	*/
+	myFunc: getFunction()
+}

data/vendor/jsdoc/app/test/tosource.js

@@ -0,0 +1,23 @@
+/**
+ * @param {Object} object
+ * @return {string}
+ */
+function valueOf(object) {}
+
+/**
+ * @param {Object} object
+ * @return {string}
+ */
+function toString(object) {}
+
+/**
+ * @param {Object} object
+ * @return {string}
+ */
+function toSource(object) {}
+
+/**
+ * @param {Object} object
+ * @return {string}
+ */
+function constructor(object) {}

data/vendor/jsdoc/app/test/variable_redefine.js

@@ -0,0 +1,14 @@
+/** @constructor */
+function Foo() {
+	var bar = 1;
+	bar = 2; // redefining a private
+	
+	this.baz = 1;
+	baz = 2; // global
+	
+	/** a private */
+	var blap = {
+		/** in here */
+		tada: 1
+	}
+}

data/vendor/jsdoc/changes.txt

@@ -0,0 +1,127 @@
+== 2.4.0n ==
+  * Ported to run on Node.JS
+
+== 2.4.0 ==
+
+  * Fixed bug that added mutiple symbols with the same name to docs.
+  * Added support for the -m option to suppress warnings for multiple docs.
+  * Added patch by brownsea42 to support quoted user variables on the command line. ( issue #281 )
+  * Fixed bug that sometimes caused links to events to be incorrect. ( issue #292 )
+  
+== 2.3.3 ==
+
+  * Fixed bug that made all fields declared with the @property tag static. ( issue #262 )
+  * Minor fix to better handle trailing slash on path to template (from jwmetrocat). ( issue #237 )
+  * Fix for @memberOf when applied to inner members. ( issue #264 )
+  * Fix for @memberOf when applied to symbols documented with @name. ( issue #260 )
+  * Applied patch from kunhualqk, fix for bug where @link to borrowed member did not resolve to parent class. ( issue #218 )
+  * Fix for @requires not linking back to the required class
+  * Added experimental support for @constructs to have an argument, the class name, when applied to a function assignment.
+  
+== 2.3.2 ==
+
+ * Minor update to the usage notes and corrected the version number displayed in the output.
+
+== 2.3.1 ==
+
+ * Fixed HTML typo in allfiles template. ( issue #228 )
+ * Modified template to display version information for classes.
+ * Modified template to better support multiple methods with the same name.
+ * Fixed bug that caused template to error when backtick characters appeared around class names.
+
+== 2.3.0 ==
+
+  * Added option -u, --unique to avoid bug that causes multiple symbols with names that differ only by case to overwrite each others output on case-insensitive filesystems. ( issue #162 )
+  * Fixed bug where {@links} in @deprecated tags did not resolve. ( issue #220 )
+  * Fixed bug that caused parens around a function to make it to be unrecognized. ( issue #213 )
+  * Fixed bug prevented explicit links to named anchors from working (thanks katgao.pku). ( issue #215 )
+  * Fixed bug that prevented full description from appearing in file overview. ( issue #224 )
+  
+== 2.2.1 ==
+
+  * Fixed bug with class template, where sorting of methods was accidentally removed (thanks dezfowler).
+  * Added missing test files for the @exports unit tests.
+
+== 2.2.0 ==
+
+  * Fixed bug that caused exception when given a folder containing non-js files, even with the x commandline option set to "js". ( issue #193 )
+  * Fixed typo in index template [patch submitted by olle]. ( issue #198 )
+  * Modified @borrows tag experimentally to allow for missing "as ..." clause.
+  * Added support for the @exports tag, to allow one symbol to be documented as another.
+  * Added support for the -S option to document code following the Secure Modules pattern.
+  
+== 2.1.0 ==
+
+  * Added support for the @event tag.
+  * Fixed bug that prevented the : character from appearing in symbol names.
+  * Fixed bug that prevented underscored symbols marked with @public being tagged as private. (issue #184 )
+  * Fixed bug that randomly affected the @memberOf tag when the name of the symbol did not include the parent name.
+  * Fixed bug that prevented templates that were not in the jsdoc-toolkit folder from being found. ( issue #176 )
+  * Added ability to check for trailing slash on template path. ( issue #177 )
+  * Modified classDesc so that it no longer is appended with the constructor desc.
+  * Fixed call to plugin onDocCommentSrc.
+  * Added missing support for inline doc comments for function return types. ( issue #189 )
+  * Added command line option -q, --quiet.
+  * Added command line option -E, --exclude. ( issue #143 )
+  * Added 2 more hooks for plugins. ( issue #163 )
+  * Added support for extending built-ins. ( issue #160 )
+  * Added "compact" option to JSDOC.JsPlate.prototype.process. ( issue #159 )
+  * @augments no longer documents static members as inherited. ( issue #138 )
+  * @link to a class now goes to the page for that class, not the constructor. ( issue #178 )
+  * Warnings of mismatched curly brace now include filename. ( issue #166 )
+  * Fixed bug affecting template paths loaded via a configuration file when the trailing slash is missing. ( issue #191 )
+  * Minor optimizations.
+
+== 2.0.2 ==
+
+  * Fixed bug that sometimes caused an example of division in the source code to be interpretted as a regex by the JsDoc Toolkit analyzer. ( issue #158 )
+  * Fixed a bug that prevented private variables marked as @public from appearing in the documentation. ( issue #161 )
+  * Fixed bug that prevented variable names with underscored properties from appearing in summaries. ( issue #173 )
+
+== 2.0.1 ==
+
+  * Fixed bug that prevented @fileOverview tag from being recognized.
+  * Added support for @fieldOf as a synonym for @field plus @memberOf.
+  * Added support for @name tag in a @fileOverview comment to control the displayed name of the file.
+  * Added support for multiple @example tags. ( issue #152 )
+  * Modified style sheet of jsdoc template to make more readable. ( issue #151 )
+  * Fixed bug that prevented @since documentation from displaying correctly when it appeared in a class. ( issue #150 )
+  * Fixed bug that caused inhertited properties to sometimes not resolve correctly. ( issue #144 )
+  * Modified so that trailing whitespace in @example is always trimmed. ( issue #153 )
+  * Added support for elseif to JsPlate. (hat tip to fredck)
+  * Added support for @location urls in the @overview comment to the jsdoc template.
+
+== Changes From Versions 1.4.0 to 2.0.0 ==
+
+  * Upgraded included version of Rhino from 1.6 to 1.7R1.
+  * Removed circular references in parsed documentation objects.
+  * Improved inheritance handling, now properties and events can be inherited same as methods.
+  * Improved handling of cross-file relationships, now having two related objects in separate files is not a problem.
+  * Improved ability to recognize membership of previously defined objects.
+  * Added ability to redefine parsing behavior with plugins.
+  * @methodOf is a synonym for @function and @memberOf.
+  * Added @default to document default values of members that are objects.
+  * Added ability to parse and refer to inner functions.
+  * Fixed bug that appeared when calling a method to set properties of the instance referred to by "this".
+  * Added ability to automatically create links to other symbols.
+  * New "jsdoc" template now produces fully W3C valid XHTML.
+  * Inline parameter type hint comments are now documented.
+  * Fixed error: Locally scoped variables (declared with var) no longer appear as global.
+  * It is now possible to run JsDoc Toolkit from any directory.
+  * Added support for inline {@link ...} tags.
+  * Added support for the -H command-line option to allow for custom content handlers.
+  * Tag names @inherits and @scope changed to @borrows and @lends.
+  ? Combining @constructor in a doclet with @lends now supported.
+  * Multiple @lend tags now supported.
+  * Added support for the @constructs tag, used inside a @lends block.
+  * Added support for the @constant tag.
+  * Fixed bug that prevented the use of [] as a default value.
+  * Added support for the @field tag.
+  * Added support for the @public tag (applied to inner functions).
+  * @namespace tag can now be applied to functions, not just object literals.
+  * Added support for the -s command line option to suppress source code output.
+  * Added new unit test framework.
+  * Underscored symbols are now treated as if they have a @private tag by default.
+  * Improved support for anonymous constructors.
+  * Added support for the nocode meta tag.
+  

data/vendor/jsdoc/conf/sample.conf

@@ -0,0 +1,31 @@
+/*
+	This is an example of one way you could set up a configuration file to more
+	conveniently define some commandline options. You might like to do this if
+	you frequently reuse the same options. Note that you don't need to define
+	every option in this file, you can combine a configuration file with
+	additional options on the commandline if your wish.
+	
+	You would include this configuration file by running JsDoc Toolkit like so:
+	java -jar jsrun.jar app/run.js -c=conf/sample.conf
+
+*/
+
+{
+	// source files to use
+	_: ['app/test/jsdoc_test.js'],
+	
+	// document all functions, even uncommented ones
+	a: true,
+	
+	// including those marked @private
+	p: true,
+	
+	// some extra variables I want to include
+	D: {generatedBy: "Michael Mathews", copyright: "2008"},
+	
+	// use this directory as the output directory
+	d: "docs",
+	
+	// use this template
+	t: "templates/jsdoc"
+}

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification 
+name: sc-docs
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Majd Taby
+- Peter Wagenet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: A tool to generate docs for SproutCore and SproutCore applications.
+email: 
+- majd@sproutcore.com
+- peterw@sproutcore.com
+executables: 
+- sc-docs
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .gitmodules
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/sc-docs
+- lib/sc_docs.rb
+- lib/sc_docs/cli.rb
+- lib/sc_docs/docs/Buildfile
+- lib/sc_docs/docs/README
+- lib/sc_docs/docs/apps/docs/Buildfile
+- lib/sc_docs/docs/apps/docs/controllers/classes.js
+- lib/sc_docs/docs/apps/docs/controllers/search_controller.js
+- lib/sc_docs/docs/apps/docs/controllers/selected_class.js
+- lib/sc_docs/docs/apps/docs/core.js
+- lib/sc_docs/docs/apps/docs/main.js
+- lib/sc_docs/docs/apps/docs/models/class.js
+- lib/sc_docs/docs/apps/docs/models/entity.js
+- lib/sc_docs/docs/apps/docs/models/method.js
+- lib/sc_docs/docs/apps/docs/models/property.js
+- lib/sc_docs/docs/apps/docs/resources/images/method_icon.png
+- lib/sc_docs/docs/apps/docs/resources/images/property_icon.png
+- lib/sc_docs/docs/apps/docs/resources/loading.rhtml
+- lib/sc_docs/docs/apps/docs/resources/main_page.css
+- lib/sc_docs/docs/apps/docs/resources/main_page.js
+- lib/sc_docs/docs/apps/docs/resources/templates/details.handlebars
+- lib/sc_docs/docs/apps/docs/resources/templates/extensions/signature.js
+- lib/sc_docs/docs/apps/docs/system/jquery_ui.js
+- lib/sc_docs/docs/apps/docs/system/showdown.js
+- lib/sc_docs/docs/apps/docs/theme.js
+- lib/sc_docs/docs/apps/docs/views/detail_list.js
+- lib/sc_docs/docs/apps/docs/views/master_list.js
+- lib/sc_docs/docs/apps/docs/views/methods_collection.js
+- lib/sc_docs/docs/apps/docs/views/properties_collection.js
+- lib/sc_docs/generator.rb
+- lib/sc_docs/server.rb
+- lib/sc_docs/templates/docs.sproutcore.com/allclasses.tmpl
+- lib/sc_docs/templates/docs.sproutcore.com/allfiles.tmpl
+- lib/sc_docs/templates/docs.sproutcore.com/class.tmpl
+- lib/sc_docs/templates/docs.sproutcore.com/index.tmpl
+- lib/sc_docs/templates/docs.sproutcore.com/output/css/api.css
+- lib/sc_docs/templates/docs.sproutcore.com/output/img/apidocs.jpg
+- lib/sc_docs/templates/docs.sproutcore.com/output/img/apidocs.png
+- lib/sc_docs/templates/docs.sproutcore.com/output/img/clearinput.png
+- lib/sc_docs/templates/docs.sproutcore.com/output/img/cross.png
+- lib/sc_docs/templates/docs.sproutcore.com/output/img/ddiagonal.png
+- lib/sc_docs/templates/docs.sproutcore.com/output/img/diagonal.png
+- lib/sc_docs/templates/docs.sproutcore.com/output/img/docbullet.jpg
+- lib/sc_docs/templates/docs.sproutcore.com/output/img/docbullet.png
+- lib/sc_docs/templates/docs.sproutcore.com/output/img/glow.png
+- lib/sc_docs/templates/docs.sproutcore.com/output/img/logo.png
+- lib/sc_docs/templates/docs.sproutcore.com/output/img/pixels.png
+- lib/sc_docs/templates/docs.sproutcore.com/output/img/search.png
+- lib/sc_docs/templates/docs.sproutcore.com/output/js/api.js
+- lib/sc_docs/templates/docs.sproutcore.com/output/js/jquery-bbq.js
+- lib/sc_docs/templates/docs.sproutcore.com/output/js/lib/jquery-1.5.1.min.js
+- lib/sc_docs/templates/docs.sproutcore.com/output/js/lib/modernizr-1.7.min.js
+- lib/sc_docs/templates/docs.sproutcore.com/output/js/plugin.js
+- lib/sc_docs/templates/docs.sproutcore.com/output/js/script.js
+- lib/sc_docs/templates/docs.sproutcore.com/publish.js
+- lib/sc_docs/templates/docs.sproutcore.com/static/default.css
+- lib/sc_docs/templates/docs.sproutcore.com/static/header.html
+- lib/sc_docs/templates/docs.sproutcore.com/static/index.html
+- lib/sc_docs/templates/docs.sproutcore.com/symbol.tmpl
+- lib/sc_docs/templates/sc_fixture/publish.js
+- lib/sc_docs/version.rb
+- sc_docs.gemspec
+- vendor/jsdoc/README.txt
+- vendor/jsdoc/app/frame.js
+- vendor/jsdoc/app/frame/Chain.js
+- vendor/jsdoc/app/frame/Dumper.js
+- vendor/jsdoc/app/frame/Hash.js
+- vendor/jsdoc/app/frame/Link.js
+- vendor/jsdoc/app/frame/Namespace.js
+- vendor/jsdoc/app/frame/Opt.js
+- vendor/jsdoc/app/frame/Reflection.js
+- vendor/jsdoc/app/frame/String.js
+- vendor/jsdoc/app/frame/Testrun.js
+- vendor/jsdoc/app/handlers/FOODOC.js
+- vendor/jsdoc/app/handlers/XMLDOC.js
+- vendor/jsdoc/app/handlers/XMLDOC/DomReader.js
+- vendor/jsdoc/app/handlers/XMLDOC/XMLDoc.js
+- vendor/jsdoc/app/handlers/XMLDOC/XMLParse.js
+- vendor/jsdoc/app/lib/JSDOC.js
+- vendor/jsdoc/app/lib/JSDOC/DocComment.js
+- vendor/jsdoc/app/lib/JSDOC/DocTag.js
+- vendor/jsdoc/app/lib/JSDOC/JsDoc.js
+- vendor/jsdoc/app/lib/JSDOC/JsPlate.js
+- vendor/jsdoc/app/lib/JSDOC/Lang.js
+- vendor/jsdoc/app/lib/JSDOC/Parser.js
+- vendor/jsdoc/app/lib/JSDOC/PluginManager.js
+- vendor/jsdoc/app/lib/JSDOC/Symbol.js
+- vendor/jsdoc/app/lib/JSDOC/SymbolSet.js
+- vendor/jsdoc/app/lib/JSDOC/TextStream.js
+- vendor/jsdoc/app/lib/JSDOC/Token.js
+- vendor/jsdoc/app/lib/JSDOC/TokenReader.js
+- vendor/jsdoc/app/lib/JSDOC/TokenStream.js
+- vendor/jsdoc/app/lib/JSDOC/Util.js
+- vendor/jsdoc/app/lib/JSDOC/Walker.js
+- vendor/jsdoc/app/main.js
+- vendor/jsdoc/app/plugins/commentSrcJson.js
+- vendor/jsdoc/app/plugins/frameworkPrototype.js
+- vendor/jsdoc/app/plugins/functionCall.js
+- vendor/jsdoc/app/plugins/publishSrcHilite.js
+- vendor/jsdoc/app/plugins/symbolLink.js
+- vendor/jsdoc/app/plugins/tagParamConfig.js
+- vendor/jsdoc/app/plugins/tagSynonyms.js
+- vendor/jsdoc/app/run.js
+- vendor/jsdoc/app/t/TestDoc.js
+- vendor/jsdoc/app/t/runner.js
+- vendor/jsdoc/app/test.js
+- vendor/jsdoc/app/test/addon.js
+- vendor/jsdoc/app/test/anon_inner.js
+- vendor/jsdoc/app/test/augments.js
+- vendor/jsdoc/app/test/augments2.js
+- vendor/jsdoc/app/test/borrows.js
+- vendor/jsdoc/app/test/borrows2.js
+- vendor/jsdoc/app/test/config.js
+- vendor/jsdoc/app/test/constructs.js
+- vendor/jsdoc/app/test/encoding.js
+- vendor/jsdoc/app/test/encoding_other.js
+- vendor/jsdoc/app/test/event.js
+- vendor/jsdoc/app/test/exports.js
+- vendor/jsdoc/app/test/functions_anon.js
+- vendor/jsdoc/app/test/functions_nested.js
+- vendor/jsdoc/app/test/global.js
+- vendor/jsdoc/app/test/globals.js
+- vendor/jsdoc/app/test/ignore.js
+- vendor/jsdoc/app/test/inner.js
+- vendor/jsdoc/app/test/jsdoc_test.js
+- vendor/jsdoc/app/test/lend.js
+- vendor/jsdoc/app/test/memberof.js
+- vendor/jsdoc/app/test/memberof2.js
+- vendor/jsdoc/app/test/memberof3.js
+- vendor/jsdoc/app/test/memberof_constructor.js
+- vendor/jsdoc/app/test/module.js
+- vendor/jsdoc/app/test/multi_methods.js
+- vendor/jsdoc/app/test/name.js
+- vendor/jsdoc/app/test/namespace_nested.js
+- vendor/jsdoc/app/test/nocode.js
+- vendor/jsdoc/app/test/oblit_anon.js
+- vendor/jsdoc/app/test/overview.js
+- vendor/jsdoc/app/test/param_inline.js
+- vendor/jsdoc/app/test/params_optional.js
+- vendor/jsdoc/app/test/prototype.js
+- vendor/jsdoc/app/test/prototype_nested.js
+- vendor/jsdoc/app/test/prototype_oblit.js
+- vendor/jsdoc/app/test/prototype_oblit_constructor.js
+- vendor/jsdoc/app/test/public.js
+- vendor/jsdoc/app/test/scripts/code.js
+- vendor/jsdoc/app/test/scripts/notcode.txt
+- vendor/jsdoc/app/test/shared.js
+- vendor/jsdoc/app/test/shared2.js
+- vendor/jsdoc/app/test/shortcuts.js
+- vendor/jsdoc/app/test/static_this.js
+- vendor/jsdoc/app/test/synonyms.js
+- vendor/jsdoc/app/test/tosource.js
+- vendor/jsdoc/app/test/variable_redefine.js
+- vendor/jsdoc/changes.txt
+- vendor/jsdoc/conf/sample.conf
+has_rdoc: true
+homepage: http://sproutcore.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Docs Generator for SproutCore
+test_files: []
+