Commit 25bd1e4d authored by Ivan Tyagov's avatar Ivan Tyagov

Allow to produce documentation out of code comments (work in progress).

parent d5500b31
...@@ -6,6 +6,7 @@ RENDERJS_MIN = renderjs.min.js ...@@ -6,6 +6,7 @@ RENDERJS_MIN = renderjs.min.js
UGLIFY_CMD = $(shell which uglifyjs || echo node ~/node_modules/uglify-js/bin/uglifyjs) UGLIFY_CMD = $(shell which uglifyjs || echo node ~/node_modules/uglify-js/bin/uglifyjs)
# npm install jslint # npm install jslint
LINT_CMD = $(shell which jslint || echo node ~/node_modules/jslint/bin/jslint.js) --terse LINT_CMD = $(shell which jslint || echo node ~/node_modules/jslint/bin/jslint.js) --terse
YUIDOC_CMD = $(shell which yuidoc)
auto: build auto: build
build: uglify build: uglify
...@@ -18,5 +19,7 @@ $(RENDERJS_MIN): $(RENDERJS) ...@@ -18,5 +19,7 @@ $(RENDERJS_MIN): $(RENDERJS)
lint: $(RENDERJS) lint: $(RENDERJS)
$(LINT_CMD) "$<" $(LINT_CMD) "$<"
doc:
$(YUIDOC_CMD) .
clean: clean:
rm -f $(RENDERJS_MIN) rm -f $(RENDERJS_MIN)
...@@ -7,15 +7,35 @@ ...@@ -7,15 +7,35 @@
* http://www.renderjs.org/documentation * http://www.renderjs.org/documentation
*/ */
// by default RenderJs will render all gadgets when page is loaded
// still it's possible to override this and use explicit gadget rendering /**
* By default RenderJs will render all gadgets when page is loaded
* still it's possible to override this and use explicit gadget rendering.
*
* @property RENDERJS_ENABLE_IMPLICIT_GADGET_RENDERING
* @type {Boolean}
* @default "true"
*/
var RENDERJS_ENABLE_IMPLICIT_GADGET_RENDERING = true; var RENDERJS_ENABLE_IMPLICIT_GADGET_RENDERING = true;
// by default RenderJs will examine and bind all interaction gadgets
// available /**
* By default RenderJs will examine and bind all interaction gadgets
* available.
*
* @property RENDERJS_ENABLE_IMPLICIT_INTERACTION_BIND
* @type {Boolean}
* @default "true"
*/
var RENDERJS_ENABLE_IMPLICIT_INTERACTION_BIND = true; var RENDERJS_ENABLE_IMPLICIT_INTERACTION_BIND = true;
// by default RenderJs will examine and create all routes /**
* By default RenderJs will examine and create all routes
*
* @property RENDERJS_ENABLE_IMPLICIT_ROUTE_CREATE
* @type {Boolean}
* @default "true"
*/
var RENDERJS_ENABLE_IMPLICIT_ROUTE_CREATE = true; var RENDERJS_ENABLE_IMPLICIT_ROUTE_CREATE = true;
// fallback for IE // fallback for IE
...@@ -24,6 +44,11 @@ if (console === undefined || console.log === undefined) { ...@@ -24,6 +44,11 @@ if (console === undefined || console.log === undefined) {
console.log = function () {}; console.log = function () {};
} }
/**
Provides the base RenderJs class
@module RenderJs
**/
var RenderJs = (function () { var RenderJs = (function () {
// a variable indicating if current gadget loading is over or not // a variable indicating if current gadget loading is over or not
var is_ready = false, current_gadget; var is_ready = false, current_gadget;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment