Fires when the value for the configuration attribute `{{name}}` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.
13 | Parameters:
14 | `e` <EventFacade> An Event Facade object with the following attribute specific properties added:
15 |
16 |
`prevVal` The value of the attribute, prior to it being set
17 |
`newVal` The value the attribute is to be set to
18 |
`attrName` The name of the attribute being set
19 |
`subAttrName` If setting a property within the attribute's value, the name of the sub-attribute property being set
20 |
21 |
22 | {{/if}}
23 |
24 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Copyright 2011 Yahoo! Inc.
2 | All rights reserved.
3 |
4 | Redistribution and use in source and binary forms, with or without
5 | modification, are permitted provided that the following conditions are met:
6 | * Redistributions of source code must retain the above copyright
7 | notice, this list of conditions and the following disclaimer.
8 | * Redistributions in binary form must reproduce the above copyright
9 | notice, this list of conditions and the following disclaimer in the
10 | documentation and/or other materials provided with the distribution.
11 | * Neither the name of the Yahoo! Inc. nor the
12 | names of its contributors may be used to endorse or promote products
13 | derived from this software without specific prior written permission.
14 |
15 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 | DISCLAIMED. IN NO EVENT SHALL YAHOO! INC. BE LIABLE FOR ANY
19 | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 | ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 |
26 |
--------------------------------------------------------------------------------
/lib/cli.js:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env node
2 |
3 | /*
4 | Copyright (c) 2011, Yahoo! Inc. All rights reserved.
5 | Code licensed under the BSD License:
6 | http://yuilibrary.com/license/
7 | */
8 |
9 | /**
10 | * Parses the arguments, creates the options and passes them to `Y.YUIDoc` and then `Y.DocBuilder`.
11 | * @class CLI
12 | * @module yuidoc
13 | */
14 |
15 | /*global Y:true */
16 | var Y = require('./index');
17 |
18 | var options = Y.Options(Y.Array(process.argv, 2));
19 |
20 | Y.log('Starting YUIDoc@' + Y.packageInfo.version + ' using YUI@' + Y.version + ' with NodeJS@' + process.versions.node, 'info', 'yuidoc');
21 |
22 | var starttime = (new Date()).getTime();
23 |
24 | options = Y.Project.init(options);
25 |
26 | Y.log('Starting YUIDoc with the following options:', 'info', 'yuidoc');
27 | var opts = Y.clone(options);
28 | if (opts.paths && opts.paths.length && (opts.paths.length > 10)) {
29 | opts.paths = [].concat(opts.paths.slice(0, 5), [''], options.paths.slice(-5));
30 | }
31 | Y.log(opts, 'info', 'yuidoc');
32 |
33 | if (options.server) {
34 | Y.Server.start(options);
35 | } else {
36 | var json = (new Y.YUIDoc(options)).run();
37 | if (json === null) {
38 | return;
39 | }
40 | options = Y.Project.mix(json, options);
41 |
42 | if (!options.parseOnly) {
43 | var builder = new Y.DocBuilder(options, json);
44 | builder.compile(function () {
45 | var endtime = (new Date()).getTime();
46 | Y.log('Completed in ' + ((endtime - starttime) / 1000) + ' seconds', 'info', 'yuidoc');
47 | });
48 | }
49 | }
50 |
--------------------------------------------------------------------------------
/output/api/assets/js/api-filter.js:
--------------------------------------------------------------------------------
1 | YUI.add('api-filter', function (Y) {
2 |
3 | Y.APIFilter = Y.Base.create('apiFilter', Y.Base, [Y.AutoCompleteBase], {
4 | // -- Initializer ----------------------------------------------------------
5 | initializer: function () {
6 | this._bindUIACBase();
7 | this._syncUIACBase();
8 | },
9 | getDisplayName: function(name) {
10 |
11 | Y.each(Y.YUIDoc.meta.allModules, function(i) {
12 | if (i.name === name && i.displayName) {
13 | name = i.displayName;
14 | }
15 | });
16 |
17 | return name;
18 | }
19 |
20 | }, {
21 | // -- Attributes -----------------------------------------------------------
22 | ATTRS: {
23 | resultHighlighter: {
24 | value: 'phraseMatch'
25 | },
26 |
27 | // May be set to "classes" or "modules".
28 | queryType: {
29 | value: 'classes'
30 | },
31 |
32 | source: {
33 | valueFn: function() {
34 | var self = this;
35 | return function(q) {
36 | var data = Y.YUIDoc.meta[self.get('queryType')],
37 | out = [];
38 | Y.each(data, function(v) {
39 | if (v.toLowerCase().indexOf(q.toLowerCase()) > -1) {
40 | out.push(v);
41 | }
42 | });
43 | return out;
44 | };
45 | }
46 | }
47 | }
48 | });
49 |
50 | }, '3.4.0', {requires: [
51 | 'autocomplete-base', 'autocomplete-highlighters', 'autocomplete-sources'
52 | ]});
53 |
--------------------------------------------------------------------------------
/themes/default/assets/js/api-filter.js:
--------------------------------------------------------------------------------
1 | YUI.add('api-filter', function (Y) {
2 |
3 | Y.APIFilter = Y.Base.create('apiFilter', Y.Base, [Y.AutoCompleteBase], {
4 | // -- Initializer ----------------------------------------------------------
5 | initializer: function () {
6 | this._bindUIACBase();
7 | this._syncUIACBase();
8 | },
9 | getDisplayName: function(name) {
10 |
11 | Y.each(Y.YUIDoc.meta.allModules, function(i) {
12 | if (i.name === name && i.displayName) {
13 | name = i.displayName;
14 | }
15 | });
16 |
17 | return name;
18 | }
19 |
20 | }, {
21 | // -- Attributes -----------------------------------------------------------
22 | ATTRS: {
23 | resultHighlighter: {
24 | value: 'phraseMatch'
25 | },
26 |
27 | // May be set to "classes" or "modules".
28 | queryType: {
29 | value: 'classes'
30 | },
31 |
32 | source: {
33 | valueFn: function() {
34 | var self = this;
35 | return function(q) {
36 | var data = Y.YUIDoc.meta[self.get('queryType')],
37 | out = [];
38 | Y.each(data, function(v) {
39 | if (v.toLowerCase().indexOf(q.toLowerCase()) > -1) {
40 | out.push(v);
41 | }
42 | });
43 | return out;
44 | };
45 | }
46 | }
47 | }
48 | });
49 |
50 | }, '3.4.0', {requires: [
51 | 'autocomplete-base', 'autocomplete-highlighters', 'autocomplete-sources'
52 | ]});
53 |
--------------------------------------------------------------------------------
/tests/input/charts/AreaSplineSeries.js:
--------------------------------------------------------------------------------
1 | /**
2 | * AreaSplineSeries renders an area graph with data points connected by a curve.
3 | *
4 | * @module charts
5 | * @class AreaSplineSeries
6 | * @constructor
7 | * @extends CartesianSeries
8 | * @uses Fills
9 | * @uses CurveUtil
10 | */
11 | Y.AreaSplineSeries = Y.Base.create("areaSplineSeries", Y.CartesianSeries, [Y.Fills, Y.CurveUtil], {
12 | /**
13 | * @protected
14 | *
15 | * Draws the series.
16 | *
17 | * @method drawSeries
18 | */
19 | drawSeries: function()
20 | {
21 | this.drawAreaSpline();
22 | }
23 | }, {
24 | ATTRS : {
25 | /**
26 | * Read-only attribute indicating the type of series.
27 | *
28 | * @attribute type
29 | * @type String
30 | * @default areaSpline
31 | */
32 | type: {
33 | value:"areaSpline"
34 | }
35 |
36 | /**
37 | * Style properties used for drawing area fills. This attribute is inherited from `Renderer`. Below are the default values:
38 | *
39 | *
40 | *
color
The color of the fill. The default value is determined by the order of the series on the graph. The color will be
41 | * retrieved from the following array:
42 | * `["#66007f", "#a86f41", "#295454", "#996ab2", "#e8cdb7", "#90bdbd","#000000","#c3b8ca", "#968373", "#678585"]`
43 | *
44 | *
alpha
Number between 0 and 1 that indicates the opacity of the fill. The default value is 1
45 | *
46 | *
47 | * @attribute styles
48 | * @type Object
49 | */
50 | }
51 | });
52 |
53 |
--------------------------------------------------------------------------------
/tests/input/charts/CircleGroup.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Abstract class for creating groups of circles with the same styles and dimensions.
3 | *
4 | * @module graphics
5 | * @class GroupCircle
6 | * @constructor
7 | */
8 | CircleGroup = function(cfg)
9 | {
10 | CircleGroup.superclass.constructor.apply(this, arguments);
11 | };
12 |
13 | CircleGroup.NAME = "circleGroup";
14 |
15 | Y.extend(CircleGroup, Y.ShapeGroup, {
16 | /**
17 | * Algorithm for drawing shape.
18 | *
19 | * @method drawShape
20 | * @param {Object} cfg Parameters used to draw the shape.
21 | */
22 | drawShape: function(cfg)
23 | {
24 | this.drawCircle(cfg.x, cfg.y, cfg.radius);
25 | }
26 | });
27 |
28 | CircleGroup.ATTRS = Y.merge(Y.ShapeGroup.ATTRS, {
29 | dimensions: {
30 | getter: function()
31 | {
32 | var dimensions = this._dimensions,
33 | radius,
34 | yRadius,
35 | width,
36 | height;
37 | if(dimensions.hasOwnProperty("radius"))
38 | {
39 | return dimensions;
40 | }
41 | else
42 | {
43 | width = dimensions.width;
44 | height = dimensions.height;
45 | radius = Y_Lang.isArray(width) ? this._getRadiusCollection(width) : (width * 0.5);
46 | yRadius = radius;
47 | return {
48 | width: width,
49 | height: height,
50 | radius: radius,
51 | yRadius: yRadius
52 | };
53 | }
54 | }
55 | }
56 | });
57 |
58 | CircleGroup.ATTRS = Y.ShapeGroup.ATTRS;
59 | Y.CircleGroup = CircleGroup;
60 |
--------------------------------------------------------------------------------
/tests/input/charts/StackedComboSplineSeries.js:
--------------------------------------------------------------------------------
1 | /**
2 | * The StackedComboSplineSeries class renders a combination of splines, plots and areaspline fills in a single series. Series
3 | * are stacked along the value axis to indicate each series contribution to a cumulative total. Each
4 | * series type has a corresponding boolean attribute indicating if it is rendered. By default, all three types are
5 | * rendered.
6 | *
7 | * @module charts
8 | * @class StackedComboSplineSeries
9 | * @extends StackedComboSeries
10 | * @uses CurveUtil
11 | * @constructor
12 | */
13 | Y.StackedComboSplineSeries = Y.Base.create("stackedComboSplineSeries", Y.StackedComboSeries, [Y.CurveUtil], {
14 | /**
15 | * @protected
16 | *
17 | * Draws the series.
18 | *
19 | * @method drawSeries
20 | */
21 | drawSeries: function()
22 | {
23 | if(this.get("showAreaFill"))
24 | {
25 | this.drawStackedAreaSpline();
26 | }
27 | if(this.get("showLines"))
28 | {
29 | this.drawSpline();
30 | }
31 | if(this.get("showMarkers"))
32 | {
33 | this.drawPlots();
34 | }
35 | }
36 | }, {
37 | ATTRS: {
38 | /**
39 | * Read-only attribute indicating the type of series.
40 | *
41 | * @attribute type
42 | * @type String
43 | * @default stackedComboSpline
44 | */
45 | type : {
46 | value : "stackedComboSpline"
47 | },
48 |
49 | /**
50 | * Indicates whether a fill is displayed.
51 | *
52 | * @attribute showAreaFill
53 | * @type Boolean
54 | * @default true
55 | */
56 | showAreaFill: {
57 | value: true
58 | }
59 | }
60 | });
61 |
--------------------------------------------------------------------------------
/output/assets/vendor/prettify/prettify.css:
--------------------------------------------------------------------------------
1 | /* Pretty printing styles. Used with prettify.js. */
2 |
3 | /* SPAN elements with the classes below are added by prettyprint. */
4 | .pln { color: #000 } /* plain text */
5 |
6 | @media screen {
7 | .str { color: #080 } /* string content */
8 | .kwd { color: #008 } /* a keyword */
9 | .com { color: #800 } /* a comment */
10 | .typ { color: #606 } /* a type name */
11 | .lit { color: #066 } /* a literal value */
12 | /* punctuation, lisp open bracket, lisp close bracket */
13 | .pun, .opn, .clo { color: #660 }
14 | .tag { color: #008 } /* a markup tag name */
15 | .atn { color: #606 } /* a markup attribute name */
16 | .atv { color: #080 } /* a markup attribute value */
17 | .dec, .var { color: #606 } /* a declaration; a variable name */
18 | .fun { color: red } /* a function name */
19 | }
20 |
21 | /* Use higher contrast and text-weight for printable form. */
22 | @media print, projection {
23 | .str { color: #060 }
24 | .kwd { color: #006; font-weight: bold }
25 | .com { color: #600; font-style: italic }
26 | .typ { color: #404; font-weight: bold }
27 | .lit { color: #044 }
28 | .pun, .opn, .clo { color: #440 }
29 | .tag { color: #006; font-weight: bold }
30 | .atn { color: #404 }
31 | .atv { color: #060 }
32 | }
33 |
34 | /* Put a border around prettyprinted code snippets. */
35 | pre.prettyprint { padding: 2px; border: 1px solid #888 }
36 |
37 | /* Specify class=linenums on a pre to get line numbering */
38 | ol.linenums { margin-top: 0; margin-bottom: 0 } /* IE indents via margin-left */
39 | li.L0,
40 | li.L1,
41 | li.L2,
42 | li.L3,
43 | li.L5,
44 | li.L6,
45 | li.L7,
46 | li.L8 { list-style-type: none }
47 | /* Alternate shading for lines */
48 | li.L1,
49 | li.L3,
50 | li.L5,
51 | li.L7,
52 | li.L9 { background: #eee }
53 |
--------------------------------------------------------------------------------
/conf/docs/assets/vendor/prettify/prettify.css:
--------------------------------------------------------------------------------
1 | /* Pretty printing styles. Used with prettify.js. */
2 |
3 | /* SPAN elements with the classes below are added by prettyprint. */
4 | .pln { color: #000 } /* plain text */
5 |
6 | @media screen {
7 | .str { color: #080 } /* string content */
8 | .kwd { color: #008 } /* a keyword */
9 | .com { color: #800 } /* a comment */
10 | .typ { color: #606 } /* a type name */
11 | .lit { color: #066 } /* a literal value */
12 | /* punctuation, lisp open bracket, lisp close bracket */
13 | .pun, .opn, .clo { color: #660 }
14 | .tag { color: #008 } /* a markup tag name */
15 | .atn { color: #606 } /* a markup attribute name */
16 | .atv { color: #080 } /* a markup attribute value */
17 | .dec, .var { color: #606 } /* a declaration; a variable name */
18 | .fun { color: red } /* a function name */
19 | }
20 |
21 | /* Use higher contrast and text-weight for printable form. */
22 | @media print, projection {
23 | .str { color: #060 }
24 | .kwd { color: #006; font-weight: bold }
25 | .com { color: #600; font-style: italic }
26 | .typ { color: #404; font-weight: bold }
27 | .lit { color: #044 }
28 | .pun, .opn, .clo { color: #440 }
29 | .tag { color: #006; font-weight: bold }
30 | .atn { color: #404 }
31 | .atv { color: #060 }
32 | }
33 |
34 | /* Put a border around prettyprinted code snippets. */
35 | pre.prettyprint { padding: 2px; border: 1px solid #888 }
36 |
37 | /* Specify class=linenums on a pre to get line numbering */
38 | ol.linenums { margin-top: 0; margin-bottom: 0 } /* IE indents via margin-left */
39 | li.L0,
40 | li.L1,
41 | li.L2,
42 | li.L3,
43 | li.L5,
44 | li.L6,
45 | li.L7,
46 | li.L8 { list-style-type: none }
47 | /* Alternate shading for lines */
48 | li.L1,
49 | li.L3,
50 | li.L5,
51 | li.L7,
52 | li.L9 { background: #eee }
53 |
--------------------------------------------------------------------------------
/lib/docview.js:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright (c) 2011, Yahoo! Inc. All rights reserved.
3 | Code licensed under the BSD License:
4 | http://yuilibrary.com/license/
5 | */
6 | YUI.add('docview', function (Y) {
7 |
8 | /*
9 | Selleck
10 | Copyright (c) 2011 Yahoo! Inc.
11 | Licensed under the BSD License.
12 | */
13 |
14 | /**
15 | View class borrowed from [Selleck](https://github.com/rgrove/selleck)
16 | The view class is a **`handlebars`** template helper.
17 | @class DocView
18 | @constructor
19 | @param {Object} data Meta data to use in this template
20 | @param {String} templateName The name of the template file to render.
21 | **/
22 | function DocView(data, templateName) {
23 | this.templateName = templateName;
24 | Y.mix(this, data);
25 | }
26 |
27 | DocView.prototype = {
28 | /**
29 | * **Mustache** `lambda` method for setting the HTML title
30 | * @method htmlTitle
31 | */
32 | htmlTitle: function () {
33 | var name = this.displayName || this.name,
34 | title = name;
35 |
36 | if (title) {
37 | if (this.projectName) {
38 | title += ' - ' + this.projectName;
39 | }
40 | } else {
41 | title = this.projectName;
42 | }
43 |
44 | return title;
45 | },
46 |
47 | /**
48 | * **Mustache** `lambda` method for setting the title
49 | * @method title
50 | */
51 | title: function () {
52 | var name = this.displayName || this.name,
53 | title = this.projectName;
54 |
55 | if (name) {
56 | title += ': ' + name;
57 | }
58 |
59 | return title;
60 | }
61 | };
62 |
63 | Y.DocView = DocView;
64 | });
65 |
--------------------------------------------------------------------------------
/tests/input/charts/StackingUtil.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Utility class used for creating stacked series.
3 | *
4 | * @module charts
5 | * @class StackingUtil
6 | * @constructor
7 | */
8 | function StackingUtil(){}
9 |
10 | StackingUtil.prototype = {
11 | /**
12 | * @protected
13 | *
14 | * Adjusts coordinate values for stacked series.
15 | *
16 | * @method _stackCoordinates
17 | */
18 | _stackCoordinates: function()
19 | {
20 | var direction = this.get("direction"),
21 | order = this.get("order"),
22 | type = this.get("type"),
23 | graph = this.get("graph"),
24 | h = graph.get("height"),
25 | seriesCollection = graph.seriesTypes[type],
26 | i = 0,
27 | len,
28 | xcoords = this.get("xcoords"),
29 | ycoords = this.get("ycoords"),
30 | prevXCoords,
31 | prevYCoords;
32 | if(order === 0)
33 | {
34 | return;
35 | }
36 | prevXCoords = seriesCollection[order - 1].get("xcoords").concat();
37 | prevYCoords = seriesCollection[order - 1].get("ycoords").concat();
38 | if(direction === "vertical")
39 | {
40 | len = prevXCoords.length;
41 | for(; i < len; ++i)
42 | {
43 | if(!isNaN(prevXCoords[i]) && !isNaN(xcoords[i]))
44 | {
45 | xcoords[i] += prevXCoords[i];
46 | }
47 | }
48 | }
49 | else
50 | {
51 | len = prevYCoords.length;
52 | for(; i < len; ++i)
53 | {
54 | if(!isNaN(prevYCoords[i]) && !isNaN(ycoords[i]))
55 | {
56 | ycoords[i] = prevYCoords[i] - (h - ycoords[i]);
57 | }
58 | }
59 | }
60 | }
61 | };
62 | Y.StackingUtil = StackingUtil;
63 |
--------------------------------------------------------------------------------
/themes/simple/partials/classes.handlebars:
--------------------------------------------------------------------------------
1 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
--------------------------------------------------------------------------------
/tests/parser_coffee.js:
--------------------------------------------------------------------------------
1 | /*global Y:true */
2 | var YUITest = require('yuitest'),
3 | Assert = YUITest.Assert,
4 | path = require('path'),
5 | Y = require(path.join(__dirname, '../', 'lib', 'index'));
6 |
7 | //Move to the test dir before running the tests.
8 | process.chdir(__dirname);
9 |
10 | var suite = new YUITest.TestSuite({
11 | name: 'Coffee Parser Test Suite',
12 | setUp: function () {
13 | var json = (new Y.YUIDoc({
14 | quiet: true,
15 | paths: ['input/'],
16 | outdir: './out',
17 | extension: '.coffee',
18 | syntaxtype: 'coffee'
19 | })).run();
20 |
21 | this.project = json.project;
22 | this.data = json;
23 | }
24 | });
25 |
26 | suite.add(new YUITest.TestCase({
27 | name: "Project Data",
28 | setUp: function () {
29 | this.project = suite.project;
30 | this.data = suite.data;
31 | },
32 | findByName: function (name, cl) {
33 | var items = this.data.classitems,
34 | ret;
35 |
36 | items.forEach(function (i) {
37 | if (i.name === name && i.class === cl) {
38 | ret = i;
39 | }
40 | });
41 |
42 | return ret;
43 | },
44 | 'test: project data': function () {
45 | Assert.areSame(path.normalize('input/coffee/test.coffee'), this.project.file, 'Project data loaded from wrong file');
46 | Assert.areSame(2, this.project.line, 'Line number is off');
47 | Assert.areSame('The test project', this.project.description, 'Description not set properly');
48 | Assert.areSame('The Tester', this.project.title, 'Title not set');
49 | Assert.areSame('admo', this.project.author, 'Author not set');
50 | Assert.areSame('entropy', this.project.contributor, 'Contributor not set');
51 | Assert.areSame('http://a.img', this.project.icon[0], 'Icon not set');
52 | Assert.areSame(1, this.project.icon.length, 'Found wring number of icons');
53 | Assert.areSame(2, this.project.url.length, 'Found wrong number of urls');
54 | Assert.areSame('http://one.url', this.project.url[0], 'URL #1 is wrong');
55 | Assert.areSame('http://two.url', this.project.url[1], 'URL #2 is wrong');
56 | }
57 | }));
58 |
59 | YUITest.TestRunner.add(suite);
60 |
--------------------------------------------------------------------------------
/docs/args/partials/help.mustache:
--------------------------------------------------------------------------------
1 |
2 | YUI Doc generates API documentation from a modified JavaDoc syntax.
3 |
4 | Current version (0.3.47)
5 |
6 | Usage: yuidoc
7 |
8 | Common Options:
9 | -c, --config, --configfile A JSON config file to provide configuration data.
10 | You can also create a yuidoc.json file and place it
11 | anywhere under your source tree and YUI Doc will find it
12 | and use it.
13 | -e, --extension The list of file extensions to parse
14 | for api documentation. (defaults to .js)
15 | -x, --exclude Directories to exclude from parsing
16 | (defaults to '.DS_Store,.svn,CVS,.git,build_rollup_tmp,build_tmp')
17 | -v, --version Show the current YUIDoc version
18 | --project-version Set the doc version for the template
19 | -N, --no-color Turn off terminal colors (for automation)
20 | -C, --no-code Turn off code generation (don't include source files in output)
21 | -n, --norecurse Do not recurse directories (default is to recurse)
22 | -S, --selleck Look for Selleck component data and attach to API meta data
23 | -V, --view Dump the Handlebars.js view data instead of writing template files
24 | -p, --parse-only Only parse the API docs and create the JSON data, do not render templates
25 | -o, --outdir Path to put the generated files (defaults to ./out)
26 | -t, --themedir Path to a custom theme directory containing Handlebars templates
27 | -H, --helpers Require these file and add Handlebars helpers. See docs for more information
28 | --charset CHARSET Use this as the default charset for all file operations. Defaults to 'utf8'
29 | -h, --help Show this help
30 | -q, --quiet Supress logging output
31 | -T, --theme Choose one of the built in themes (default is default)
32 | --syntaxtype Choose comment syntax type (default is js)
33 | --server Fire up the YUIDoc server for faster API doc developement. Pass optional port to listen on. (default is 3000)
34 | --lint Lint your docs, will print parser warnings and exit code 1 if there are any
35 |
36 | Supply a list of paths (shell globbing is handy here)
37 |
38 |
--------------------------------------------------------------------------------
/themes/simple/partials/method.handlebars:
--------------------------------------------------------------------------------
1 |
2 |
57 |
--------------------------------------------------------------------------------
/tests/input/charts/AreaSeries.js:
--------------------------------------------------------------------------------
1 | /**
2 | * The AreaSeries class renders quantitative data on a graph by creating a fill between 0
3 | * and the relevant data points.
4 | *
5 | * @module charts
6 | * @class AreaSeries
7 | * @extends CartesianSeries
8 | * @uses Fills
9 | * @constructor
10 | */
11 | Y.AreaSeries = Y.Base.create("areaSeries", Y.CartesianSeries, [Y.Fills], {
12 | /**
13 | * @protected
14 | *
15 | * Renders the series.
16 | *
17 | * @method drawSeries
18 | */
19 | drawSeries: function()
20 | {
21 | this.drawFill.apply(this, this._getClosingPoints());
22 | },
23 |
24 | /**
25 | * @protected
26 | *
27 | * Method used by `styles` setter. Overrides base implementation.
28 | *
29 | * @method _setStyles
30 | * @param {Object} newStyles Hash of properties to update.
31 | * @return Object
32 | */
33 | _setStyles: function(val)
34 | {
35 | if(!val.area)
36 | {
37 | val = {area:val};
38 | }
39 | return Y.AreaSeries.superclass._setStyles.apply(this, [val]);
40 | },
41 |
42 | /**
43 | * @protected
44 | *
45 | * Gets the default value for the `styles` attribute. Overrides
46 | * base implementation.
47 | *
48 | * @method _getDefaultStyles
49 | * @return Object
50 | */
51 | _getDefaultStyles: function()
52 | {
53 | var styles = this._mergeStyles({area:this._getAreaDefaults()}, Y.AreaSeries.superclass._getDefaultStyles());
54 | return styles;
55 | }
56 | },
57 | {
58 | ATTRS: {
59 | /**
60 | * Read-only attribute indicating the type of series.
61 | *
62 | * @attribute type
63 | * @type String
64 | * @default area
65 | */
66 | type: {
67 | value:"area"
68 | }
69 |
70 | /**
71 | * Style properties used for drawing area fills. This attribute is inherited from `Renderer`. Below are the default values:
72 | *
73 | *
74 | *
color
The color of the fill. The default value is determined by the order of the series on the graph. The color will be
75 | * retrieved from the following array:
76 | * `["#66007f", "#a86f41", "#295454", "#996ab2", "#e8cdb7", "#90bdbd","#000000","#c3b8ca", "#968373", "#678585"]`
77 | *
78 | *
alpha
Number between 0 and 1 that indicates the opacity of the fill. The default value is 1
93 |
--------------------------------------------------------------------------------
/tests/input/charts/SplineSeries.js:
--------------------------------------------------------------------------------
1 | /**
2 | * SplineSeries renders a graph with data points connected by a curve.
3 | *
4 | * @module charts
5 | * @class SplineSeries
6 | * @constructor
7 | * @extends CartesianSeries
8 | * @uses CurveUtil
9 | * @uses Lines
10 | */
11 | Y.SplineSeries = Y.Base.create("splineSeries", Y.LineSeries, [Y.CurveUtil, Y.Lines], {
12 | /**
13 | * @protected
14 | *
15 | * Draws the series.
16 | *
17 | * @method drawSeries
18 | */
19 | drawSeries: function()
20 | {
21 | this.drawSpline();
22 | }
23 | }, {
24 | ATTRS : {
25 | /**
26 | * Read-only attribute indicating the type of series.
27 | *
28 | * @attribute type
29 | * @type String
30 | * @default spline
31 | */
32 | type : {
33 | value:"spline"
34 | }
35 |
36 | /**
37 | * Style properties used for drawing lines. This attribute is inherited from `Renderer`. Below are the default values:
38 | *
39 | *
color
The color of the line. The default value is determined by the order of the series on the graph. The color will be
40 | * retrieved from the following array:
41 | * `["#426ab3", "#d09b2c", "#000000", "#b82837", "#b384b5", "#ff7200", "#779de3", "#cbc8ba", "#7ed7a6", "#007a6c"]`
42 | *
weight
Number that indicates the width of the line. The default value is 6.
43 | *
alpha
Number between 0 and 1 that indicates the opacity of the line. The default value is 1.
44 | *
lineType
Indicates whether the line is solid or dashed. The default value is solid.
45 | *
dashLength
When the `lineType` is dashed, indicates the length of the dash. The default value is 10.
46 | *
gapSpace
When the `lineType` is dashed, indicates the distance between dashes. The default value is 10.
47 | *
connectDiscontinuousPoints
Indicates whether or not to connect lines when there is a missing or null value between points. The default value is true.
48 | *
discontinuousType
Indicates whether the line between discontinuous points is solid or dashed. The default value is solid.
49 | *
discontinuousDashLength
When the `discontinuousType` is dashed, indicates the length of the dash. The default value is 10.
50 | *
discontinuousGapSpace
When the `discontinuousType` is dashed, indicates the distance between dashes. The default value is 10.
51 | *
52 | *
53 | * @attribute styles
54 | * @type Object
55 | */
56 | }
57 | });
58 |
59 |
60 |
61 |
62 |
63 |
64 |
--------------------------------------------------------------------------------
/tests/input/charts/StackedAxis.js:
--------------------------------------------------------------------------------
1 | /**
2 | * StackedAxis manages stacked numeric data on an axis.
3 | *
4 | * @module charts
5 | * @class StackedAxis
6 | * @constructor
7 | * @param {Object} config (optional) Configuration parameters for the Chart.
8 | * @extends NumericAxis
9 | */
10 | function StackedAxis(config)
11 | {
12 | StackedAxis.superclass.constructor.apply(this, arguments);
13 | }
14 |
15 | StackedAxis.NAME = "stackedAxis";
16 |
17 |
18 | Y.extend(StackedAxis, Y.NumericAxis,
19 | {
20 | /**
21 | * Calculates the maximum and minimum values for the `Axis`.
22 | *
23 | * @method _updateMinAndMax
24 | * @private
25 | */
26 | _updateMinAndMax: function()
27 | {
28 | var max = 0,
29 | min = 0,
30 | pos = 0,
31 | neg = 0,
32 | len = 0,
33 | i = 0,
34 | key,
35 | num,
36 | keys = this.get("keys"),
37 | setMin = this.get("setMin"),
38 | setMax = this.get("setMax");
39 |
40 | for(key in keys)
41 | {
42 | if(keys.hasOwnProperty(key))
43 | {
44 | len = Math.max(len, keys[key].length);
45 | }
46 | }
47 | for(; i < len; ++i)
48 | {
49 | pos = 0;
50 | neg = 0;
51 | for(key in keys)
52 | {
53 | if(keys.hasOwnProperty(key))
54 | {
55 | num = keys[key][i];
56 | if(isNaN(num))
57 | {
58 | continue;
59 | }
60 | if(num >= 0)
61 | {
62 | pos += num;
63 | }
64 | else
65 | {
66 | neg += num;
67 | }
68 | }
69 | }
70 | if(pos > 0)
71 | {
72 | max = Math.max(max, pos);
73 | }
74 | else
75 | {
76 | max = Math.max(max, neg);
77 | }
78 | if(neg < 0)
79 | {
80 | min = Math.min(min, neg);
81 | }
82 | else
83 | {
84 | min = Math.min(min, pos);
85 | }
86 | }
87 | this._actualMaximum = max;
88 | this._actualMinimum = min;
89 | if(setMax)
90 | {
91 | max = this._setMaximum;
92 | }
93 | if(setMin)
94 | {
95 | min = this._setMinimum;
96 | }
97 | this._roundMinAndMax(min, max, setMin, setMax);
98 | }
99 | });
100 |
101 | Y.StackedAxis = StackedAxis;
102 |
103 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | YUIDoc Doc parser
2 | =================
3 |
4 | YUIDoc is a [Node.js](http://nodejs.org/) application used at build time to
5 | generate API documentation for JavaScript code. YUIDoc is comment-driven and supports a wide
6 | range of JavaScript coding styles. The output of YUI Doc is API documentation formatted as a
7 | set of HTML pages including information about methods, properties, custom events and
8 | inheritance for JavaScript objects. YUIDoc was orignally written for the YUI Project;
9 | it uses YUI JavaScript and CSS in the generated files and it supports common YUI
10 | conventions like Custom Events. That said, it can be used easily and productively on non-YUI code.
11 |
12 | Current Build Status
13 | --------------------
14 |
15 | [](http://travis-ci.org/yui/yuidoc)
16 |
17 | Installation
18 | ------------
19 |
20 | npm -g i yuidocjs
21 |
22 |
23 | Documentation
24 | -------------
25 |
26 | * [User Guides](http://yui.github.com/yuidoc/)
27 | * [API Docs](http://yui.github.com/yuidoc/api/)
28 | * [Support Mailing List](https://groups.google.com/forum/#!forum/yuidoc)
29 |
30 | Released under the YUI BSD License
31 | ----------------------------------
32 |
33 | Copyright 2012 Yahoo! Inc.
34 | All rights reserved.
35 |
36 | Redistribution and use in source and binary forms, with or without
37 | modification, are permitted provided that the following conditions are met:
38 |
39 | * Redistributions of source code must retain the above copyright
40 | notice, this list of conditions and the following disclaimer.
41 | * Redistributions in binary form must reproduce the above copyright
42 | notice, this list of conditions and the following disclaimer in the
43 | documentation and/or other materials provided with the distribution.
44 | * Neither the name of the Yahoo! Inc. nor the
45 | names of its contributors may be used to endorse or promote products
46 | derived from this software without specific prior written permission.
47 |
48 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
49 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
50 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
51 | DISCLAIMED. IN NO EVENT SHALL YAHOO! INC. BE LIABLE FOR ANY
52 | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
53 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
54 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
55 | ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
56 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
57 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
58 |
--------------------------------------------------------------------------------
/themes/simple/partials/sidebar.handlebars:
--------------------------------------------------------------------------------
1 |
YUIDoc is a Node.js application that
5 | generates API documentation from comments in source, using a syntax similar
6 | to tools like Javadoc and Doxygen. YUIDoc provides:
7 |
8 |
9 |
Live previews. YUIDoc includes a
10 | standalone doc server,
11 | making it trivial to preview your docs as you write.
12 |
Modern markup. YUIDoc's generated documentation is an
13 | attractive,
14 | functional web application with real URLs and graceful
15 | fallbacks for spiders and other agents that can't run JavaScript.
16 |
Wide language support. YUIDoc was originally designed for
17 | the YUI project, but it is not
18 | tied to any particular library or programming language.
19 | You can use it with any language that supports
20 | `/* */` comment blocks.
YUIDoc parses a modified form of JSDoc tags.
49 | This section provides a taste of some of the more common constructs in YUIDoc.
50 | For more information, refer to the "YUIDoc Syntax Reference".
51 |
52 |
Example Class Block
53 | ```
54 | /**
55 | * This is the description for my class.
56 | *
57 | * @class MyClass
58 | * @constructor
59 | */
60 | ```
61 |
Example Method Block
62 | ```
63 | /**
64 | * My method description. Like other pieces of your comment blocks,
65 | * this can span multiple lines.
66 | *
67 | * @method methodName
68 | * @param {String} foo Argument 1
69 | * @param {Object} config A config object
70 | * @param {String} config.name The name on the config object
71 | * @param {Function} config.callback A callback function on the config object
72 | * @param {Boolean} [extra=false] Do extra, optional work
73 | * @return {Boolean} Returns true on success
74 | */
75 | ```
76 |
77 |
Example Property Block
78 | ```
79 | /**
80 | * My property description. Like other pieces of your comment blocks,
81 | * this can span multiple lines.
82 | *
83 | * @property propertyName
84 | * @type {Object}
85 | * @default "foo"
86 | */
87 | ```
88 |
--------------------------------------------------------------------------------
/tests/utils.js:
--------------------------------------------------------------------------------
1 | /*global Y:true */
2 | var YUITest = require('yuitest'),
3 | Assert = YUITest.Assert,
4 | path = require('path'),
5 | Y = require(path.join(__dirname, '../', 'lib', 'index'));
6 |
7 | var suite = new YUITest.TestSuite({
8 | name: 'Utils Test Suite'
9 | });
10 |
11 | suite.add(new YUITest.TestCase({
12 | name: 'getProjectData Folder Priority',
13 | 'test: Nearest Folder Priority': function () {
14 | var d = Y.getProjectData('input/folders1');
15 | Assert.areEqual('yuidoc-root', d.name, 'must use nearest yuidoc.json first');
16 | },
17 | 'test: Finds package.json': function () {
18 | var d = Y.getProjectData('input/folders2');
19 | Assert.areEqual('yuidoc-two', d.name, 'used deep yuidoc.json');
20 | Assert.areEqual('package-root', d.description, 'used shallow package.json');
21 | },
22 | 'test: Finds package.json in same folder as yuidoc.json': function () {
23 | var d = Y.getProjectData('input/folders3');
24 | Assert.areEqual('yuidoc-root', d.name, 'used deep yuidoc.json');
25 | Assert.areEqual('package-root', d.description, 'used deep package.json');
26 | },
27 | 'test: Ignores package.json in deeper folder than yuidoc.json': function () {
28 | var d = Y.getProjectData('input/folders4');
29 | Assert.areEqual('yuidoc-one', d.name, 'used deep yuidoc.json');
30 | Assert.isUndefined(d.description, 'used deep package.json');
31 | },
32 | 'test: Must be breadth-first': function () {
33 | var d = Y.getProjectData('input/folders5');
34 | Assert.areEqual('yuidoc-two', d.name, 'used wrong yuidoc.json');
35 | Assert.areEqual('package-two', d.description, 'used wrong package.json');
36 | }
37 | }));
38 |
39 | suite.add(new YUITest.TestCase({
40 | name: 'validatePaths',
41 | 'test: path globs': function () {
42 | var options;
43 |
44 | process.chdir(path.join(__dirname, 'input/globbing'));
45 |
46 | // Simulate a path provided by a configuration...
47 | // first with a String path
48 | options = {
49 | paths: '**/yui/src/*'
50 | };
51 | options = Y.Project.init(options);
52 |
53 | Assert.isArray(options.paths, 'Failed to set path');
54 | Assert.areSame(3, options.paths.length, 'Failed to retrieve all path options');
55 |
56 | // then with an Array of path
57 | options = {
58 | paths: [
59 | '**/yui/src/*'
60 | ]
61 | };
62 | options = Y.Project.init(options);
63 |
64 | Assert.isArray(options.paths, 'Failed to set path');
65 | Assert.areSame(3, options.paths.length, 'Failed to retrieve all path options');
66 |
67 |
68 | // Test with a path as passed to Y.Options
69 | options = Y.Options([
70 | '**/yui/src/*'
71 | ]);
72 | options = Y.Project.init(options);
73 |
74 | Assert.isArray(options.paths, 'Failed to set path');
75 | Assert.areSame(3, options.paths.length, 'Failed to retrieve all path options');
76 | }
77 | }));
78 |
79 | YUITest.TestRunner.add(suite);
80 |
--------------------------------------------------------------------------------
/tests/input/charts/Renderer.js:
--------------------------------------------------------------------------------
1 | /**
2 | * The Renderer class is a base class for chart components that use the `styles`
3 | * attribute.
4 | *
5 | * @module charts
6 | * @class Renderer
7 | * @constructor
8 | */
9 | function Renderer(){}
10 |
11 | Renderer.ATTRS = {
12 | /**
13 | * Style properties for class
14 | *
15 | * @attribute styles
16 | * @type Object
17 | */
18 | styles:
19 | {
20 | getter: function()
21 | {
22 | this._styles = this._styles || this._getDefaultStyles();
23 | return this._styles;
24 | },
25 |
26 | setter: function(val)
27 | {
28 | this._styles = this._setStyles(val);
29 | }
30 | },
31 |
32 | /**
33 | * The graphic in which drawings will be rendered.
34 | *
35 | * @attribute graphic
36 | * @type Graphic
37 | */
38 | graphic: {}
39 | };
40 | Renderer.NAME = "renderer";
41 |
42 | Renderer.prototype = {
43 | /**
44 | * Storage for `styles` attribute.
45 | *
46 | * @property _styles
47 | * @type Object
48 | * @private
49 | */
50 | _styles: null,
51 |
52 | /**
53 | * Method used by `styles` setter.
54 | *
55 | * @method _setStyles
56 | * @param {Object} newStyles Hash of properties to update.
57 | * @return Object
58 | * @protected
59 | */
60 | _setStyles: function(newstyles)
61 | {
62 | var styles = this.get("styles");
63 | return this._mergeStyles(newstyles, styles);
64 | },
65 |
66 | /**
67 | * Merges to object literals so that only specified properties are
68 | * overwritten.
69 | *
70 | * @method _mergeStyles
71 | * @param {Object} a Hash of new styles
72 | * @param {Object} b Hash of original styles
73 | * @return Object
74 | * @protected
75 | */
76 | _mergeStyles: function(a, b)
77 | {
78 | if(!b)
79 | {
80 | b = {};
81 | }
82 | var newstyles = Y.merge(b, {});
83 | Y.Object.each(a, function(value, key, a)
84 | {
85 | if(b.hasOwnProperty(key) && Y_Lang.isObject(value) && !Y_Lang.isFunction(value) && !Y_Lang.isArray(value))
86 | {
87 | newstyles[key] = this._mergeStyles(value, b[key]);
88 | }
89 | else
90 | {
91 | newstyles[key] = value;
92 | }
93 | }, this);
94 | return newstyles;
95 | },
96 |
97 | /**
98 | * Gets the default value for the `styles` attribute.
99 | *
100 | * @method _getDefaultStyles
101 | * @return Object
102 | * @protected
103 | */
104 | _getDefaultStyles: function()
105 | {
106 | return {padding:{
107 | top:0,
108 | right: 0,
109 | bottom: 0,
110 | left: 0
111 | }};
112 | }
113 | };
114 |
115 | Y.augment(Renderer, Y.Attribute);
116 | Y.Renderer = Renderer;
117 |
118 |
--------------------------------------------------------------------------------
/output/api/assets/js/api-search.js:
--------------------------------------------------------------------------------
1 | YUI.add('api-search', function (Y) {
2 |
3 | var Lang = Y.Lang,
4 | Node = Y.Node,
5 | YArray = Y.Array;
6 |
7 | Y.APISearch = Y.Base.create('apiSearch', Y.Base, [Y.AutoCompleteBase], {
8 | // -- Public Properties ----------------------------------------------------
9 | RESULT_TEMPLATE:
10 | '
The color of the line. The default value is determined by the order of the series on the graph. The color will be
71 | * retrieved from the following array:
72 | * `["#426ab3", "#d09b2c", "#000000", "#b82837", "#b384b5", "#ff7200", "#779de3", "#cbc8ba", "#7ed7a6", "#007a6c"]`
73 | *
weight
Number that indicates the width of the line. The default value is 6.
74 | *
alpha
Number between 0 and 1 that indicates the opacity of the line. The default value is 1.
75 | *
lineType
Indicates whether the line is solid or dashed. The default value is solid.
76 | *
dashLength
When the `lineType` is dashed, indicates the length of the dash. The default value is 10.
77 | *
gapSpace
When the `lineType` is dashed, indicates the distance between dashes. The default value is 10.
78 | *
connectDiscontinuousPoints
Indicates whether or not to connect lines when there is a missing or null value between points. The default value is true.
79 | *
discontinuousType
Indicates whether the line between discontinuous points is solid or dashed. The default value is solid.
80 | *
discontinuousDashLength
When the `discontinuousType` is dashed, indicates the length of the dash. The default value is 10.
81 | *
discontinuousGapSpace
When the `discontinuousType` is dashed, indicates the distance between dashes. The default value is 10.
82 | *
83 | *
84 | * @attribute styles
85 | * @type Object
86 | */
87 | }
88 | });
89 |
90 |
91 |
92 |
93 |
94 |
95 |
--------------------------------------------------------------------------------
/tests/input/charts/CurveUtil.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Utility class used for calculating curve points.
3 | *
4 | * @module charts
5 | * @class CurveUtil
6 | * @constructor
7 | */
8 | function CurveUtil()
9 | {
10 | }
11 |
12 | CurveUtil.prototype = {
13 | /**
14 | * Creates an array of start, end and control points for splines.
15 | *
16 | * @method getCurveControlPoints
17 | * @param {Array} xcoords Collection of x-coordinates used for calculate the curves
18 | * @param {Array} ycoords Collection of y-coordinates used for calculate the curves
19 | * @return Object
20 | * @protected
21 | */
22 | getCurveControlPoints: function(xcoords, ycoords)
23 | {
24 | var outpoints = [],
25 | i = 1,
26 | l = xcoords.length - 1,
27 | xvals = [],
28 | yvals = [];
29 |
30 |
31 | // Too few points, need at least two
32 | if (l < 1)
33 | {
34 | return null;
35 | }
36 |
37 | outpoints[0] = {
38 | startx: xcoords[0],
39 | starty: ycoords[0],
40 | endx: xcoords[1],
41 | endy: ycoords[1]
42 | };
43 |
44 | // Special case, the Bezier should be a straight line
45 | if (l === 1)
46 | {
47 | outpoints[0].ctrlx1 = (2.0*xcoords[0] + xcoords[1])/3.0;
48 | outpoints[0].ctrly2 = (2.0*ycoords[0] + ycoords[1])/3.0;
49 | outpoints[0].ctrlx2 = 2.0*outpoints[0].ctrlx1 - xcoords[0];
50 | outpoints[0].ctrly2 = 2.0*outpoints[0].ctrly1 - ycoords[0];
51 | return outpoints;
52 | }
53 |
54 | for (; i < l; ++i)
55 | {
56 | outpoints.push({startx: Math.round(xcoords[i]), starty: Math.round(ycoords[i]), endx: Math.round(xcoords[i+1]), endy: Math.round(ycoords[i+1])});
57 | xvals[i] = 4.0 * xcoords[i] + 2*xcoords[i+1];
58 | yvals[i] = 4.0*ycoords[i] + 2*ycoords[i+1];
59 | }
60 |
61 | xvals[0] = xcoords[0] + (2.0 * xcoords[1]);
62 | xvals[l-1] = (8.0 * xcoords[l-1] + xcoords[l]) / 2.0;
63 | xvals = this.getControlPoints(xvals.concat());
64 | yvals[0] = ycoords[0] + (2.0 * ycoords[1]);
65 | yvals[l-1] = (8.0 * ycoords[l-1] + ycoords[l]) / 2.0;
66 | yvals = this.getControlPoints(yvals.concat());
67 |
68 | for (i = 0; i < l; ++i)
69 | {
70 | outpoints[i].ctrlx1 = Math.round(xvals[i]);
71 | outpoints[i].ctrly1 = Math.round(yvals[i]);
72 |
73 | if (i < l-1)
74 | {
75 | outpoints[i].ctrlx2 = Math.round(2*xcoords[i+1] - xvals[i+1]);
76 | outpoints[i].ctrly2 = Math.round(2*ycoords[i+1] - yvals[i+1]);
77 | }
78 | else
79 | {
80 | outpoints[i].ctrlx2 = Math.round((xcoords[l] + xvals[l-1])/2);
81 | outpoints[i].ctrly2 = Math.round((ycoords[l] + yvals[l-1])/2);
82 | }
83 | }
84 |
85 | return outpoints;
86 | },
87 |
88 | /**
89 | * Gets the control points for the curve.
90 | *
91 | * @method getControlPoints
92 | * @param {Array} vals Collection of values coords used to generate control points.
93 | * @return Array
94 | * @private
95 | */
96 | getControlPoints: function(vals)
97 | {
98 | var l = vals.length,
99 | x = [],
100 | tmp = [],
101 | b = 2.0,
102 | i = 1;
103 | x[0] = vals[0] / b;
104 | for (; i < l; ++i)
105 | {
106 | tmp[i] = 1/b;
107 | b = (i < l-1 ? 4.0 : 3.5) - tmp[i];
108 | x[i] = (vals[i] - x[i-1]) / b;
109 | }
110 |
111 | for (i = 1; i < l; ++i)
112 | {
113 | x[l-i-1] -= tmp[l-i] * x[l-i];
114 | }
115 |
116 | return x;
117 | }
118 | };
119 | Y.CurveUtil = CurveUtil;
120 |
--------------------------------------------------------------------------------
/lib/help.js:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright (c) 2011, Yahoo! Inc. All rights reserved.
3 | Code licensed under the BSD License:
4 | http://yuilibrary.com/license/
5 | */
6 | YUI.add('help', function (Y) {
7 |
8 | /**
9 | * Shows the help text
10 | * @module yuidoc
11 | * @class Help
12 | */
13 |
14 | /**
15 | * The help text to display
16 | * @private
17 | * @property help
18 | * @type Array
19 | */
20 | var help = [
21 | "",
22 | "YUI Doc generates API documentation from a modified JavaDoc syntax.",
23 | "",
24 | "Current version ({VERSION})",
25 | "",
26 | "Usage: yuidoc ",
27 | "",
28 | "Common Options:",
29 | " -c, --config, --configfile A JSON config file to provide configuration data.",
30 | " You can also create a yuidoc.json file and place it",
31 | " anywhere under your source tree and YUI Doc will find it",
32 | " and use it.",
33 | " -e, --extension The list of file extensions to parse ",
34 | " for api documentation. (defaults to .js)",
35 | " -x, --exclude Directories to exclude from parsing ",
36 | " (defaults to '.DS_Store,.svn,CVS,.git,build_rollup_tmp,build_tmp')",
37 | " -v, --version Show the current YUIDoc version",
38 | " --project-version Set the doc version for the template",
39 | " -N, --no-color Turn off terminal colors (for automation)",
40 | " -C, --no-code Turn off code generation (don't include source files in output)",
41 | " -n, --norecurse Do not recurse directories (default is to recurse)",
42 | " -S, --selleck Look for Selleck component data and attach to API meta data",
43 | " -V, --view Dump the Handlebars.js view data instead of writing template files",
44 | " -p, --parse-only Only parse the API docs and create the JSON data, do not render templates",
45 | " -o, --outdir Path to put the generated files (defaults to ./out)",
46 | " -t, --themedir Path to a custom theme directory containing Handlebars templates",
47 | " -H, --helpers Require these file and add Handlebars helpers. See docs for more information",
48 | " --charset CHARSET Use this as the default charset for all file operations. Defaults to 'utf8'",
49 | " -h, --help Show this help",
50 | " -q, --quiet Supress logging output",
51 | " -T, --theme Choose one of the built in themes (default is default)",
52 | " --syntaxtype Choose comment syntax type (default is js)",
53 | " --server Fire up the YUIDoc server for faster API doc developement. Pass optional port to listen on. (default is 3000)",
54 | " --lint Lint your docs, will print parser warnings and exit code 1 if there are any",
55 | "",
56 | " Supply a list of paths (shell globbing is handy here)",
57 | "",
58 | ].join('\n');
59 |
60 | /**
61 | * Render the help message as a string
62 | * @method renderHelp
63 | * @return {String} The help screen to display
64 | */
65 | Y.renderHelp = function () {
66 | return Y.Lang.sub(help, {
67 | VERSION: Y.packageInfo.version
68 | });
69 | };
70 | /**
71 | * Display the help message, write it to the screen and exit
72 | * @method showHelp
73 | */
74 | Y.showHelp = function () {
75 | console.error(Y.renderHelp());
76 | process.exit(0); //Shouldn't exit one on help
77 | };
78 | });
79 |
--------------------------------------------------------------------------------
/tests/input/test2/dump/dump.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Returns a simple string representation of the object or array.
3 | * Other types of objects will be returned unprocessed. Arrays
4 | * are expected to be indexed. Use object notation for
5 | * associative arrays.
6 | *
7 | * If included, the dump method is added to the YUI instance.
8 | *
9 | * @module dump
10 | */
11 |
12 | var L = Y.Lang,
13 | OBJ = '{...}',
14 | FUN = 'f(){...}',
15 | COMMA = ', ',
16 | ARROW = ' => ',
17 |
18 | /**
19 | * The following methods are added to the YUI instance
20 | * @class YUI~dump
21 | */
22 |
23 | /**
24 | * Returns a simple string representation of the object or array.
25 | * Other types of objects will be returned unprocessed. Arrays
26 | * are expected to be indexed. Use object notation for
27 | * associative arrays.
28 | *
29 | * This method is in the 'dump' module, which is not bundled with
30 | * the core YUI object
31 | *
32 | * @method dump
33 | * @param {object} o The object to dump.
34 | * @param {int} d How deep to recurse child objects, default 3.
35 | * @return {string} the dump result.
36 | */
37 | dump = function(o, d) {
38 | var i, len, s = [], type = L.type(o);
39 |
40 | // Cast non-objects to string
41 | // Skip dates because the std toString is what we want
42 | // Skip HTMLElement-like objects because trying to dump
43 | // an element will cause an unhandled exception in FF 2.x
44 | if (!L.isObject(o)) {
45 | return o + '';
46 | } else if (type == 'date') {
47 | return o;
48 | } else if (o.nodeType && o.tagName) {
49 | return o.tagName + '#' + o.id;
50 | } else if (o.document && o.navigator) {
51 | return 'window';
52 | } else if (o.location && o.body) {
53 | return 'document';
54 | } else if (type == 'function') {
55 | return FUN;
56 | }
57 |
58 | // dig into child objects the depth specifed. Default 3
59 | d = (L.isNumber(d)) ? d : 3;
60 |
61 | // arrays [1, 2, 3]
62 | if (type == 'array') {
63 | s.push('[');
64 | for (i = 0, len = o.length; i < len; i = i + 1) {
65 | if (L.isObject(o[i])) {
66 | s.push((d > 0) ? L.dump(o[i], d - 1) : OBJ);
67 | } else {
68 | s.push(o[i]);
69 | }
70 | s.push(COMMA);
71 | }
72 | if (s.length > 1) {
73 | s.pop();
74 | }
75 | s.push(']');
76 | // regexp /foo/
77 | } else if (type == 'regexp') {
78 | s.push(o.toString());
79 | // objects {k1 => v1, k2 => v2}
80 | } else {
81 | s.push('{');
82 | for (i in o) {
83 | if (o.hasOwnProperty(i)) {
84 | try {
85 | s.push(i + ARROW);
86 | if (L.isObject(o[i])) {
87 | s.push((d > 0) ? L.dump(o[i], d - 1) : OBJ);
88 | } else {
89 | s.push(o[i]);
90 | }
91 | s.push(COMMA);
92 | } catch (e) {
93 | s.push('Error: ' + e.message);
94 | }
95 | }
96 | }
97 | if (s.length > 1) {
98 | s.pop();
99 | }
100 | s.push('}');
101 | }
102 |
103 | return s.join('');
104 | };
105 |
106 | Y.dump = dump;
107 | L.dump = dump;
108 |
109 |
--------------------------------------------------------------------------------
/lib/index.js:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright (c) 2011, Yahoo! Inc. All rights reserved.
3 | Code licensed under the BSD License:
4 | http://yuilibrary.com/license/
5 | */
6 | /*global YUI:true, Y:true */
7 | /**
8 | Module creates the YUI instance with the required modules, uses them and exports the **Y** to be used
9 | by the _CLI class_ or by extenders: `require('yuidocjs');`
10 | You can use it like this:
11 |
12 | var options = {
13 | paths: [ './lib' ],
14 | outdir: './out'
15 | };
16 |
17 | var Y = require('yuidocjs');
18 | var json = (new Y.YUIDoc(options)).run();
19 |
20 | @class Main
21 | @exports {YUI} Y A YUI instance
22 | @module yuidoc
23 | */
24 | //Hacking in debug support
25 | var args = process.argv.slice(2);
26 | var debug = false;
27 |
28 | args.forEach(function (item) {
29 | if (item.toLowerCase() === '--debug') {
30 | debug = true;
31 | }
32 | });
33 |
34 | var YUI = require('yui' + (debug ? '/debug' : '')).YUI,
35 | path = require('path'),
36 | fs = require('graceful-fs'),
37 | metaPath = path.join(__dirname, '../', 'package.json');
38 |
39 |
40 | process.on('uncaughtException', function (msg) {
41 | var meta = JSON.parse(fs.readFileSync(metaPath)),
42 | inst = YUI(),
43 | useColor = (Y ? Y.config.useColor : false);
44 |
45 | inst.applyConfig({
46 | debug: true,
47 | useColor: useColor
48 | });
49 |
50 | inst.log('--------------------------------------------------------------------------', 'error');
51 | inst.log('An uncaught YUIDoc error has occurred, stack trace given below', 'error');
52 | inst.log('--------------------------------------------------------------------------', 'error');
53 | inst.log(msg.stack || msg.message || msg, 'error');
54 | inst.log('--------------------------------------------------------------------------', 'error');
55 | inst.log('Node.js version: ' + process.version, 'error');
56 | inst.log('YUI version: ' + YUI.version, 'error');
57 | inst.log('YUIDoc version: ' + meta.version, 'error');
58 | inst.log('Please file all tickets here: ' + meta.bugs.url, 'error');
59 | inst.log('--------------------------------------------------------------------------', 'error');
60 |
61 | process.exit(1);
62 | });
63 |
64 | var Y = YUI({
65 | modules: {
66 | help: {
67 | fullpath: path.join(__dirname, 'help.js')
68 | },
69 | options: {
70 | fullpath: path.join(__dirname, 'options.js')
71 | },
72 | docparser: {
73 | fullpath: path.join(__dirname, 'docparser.js'),
74 | requires: ['base-base', 'json-stringify']
75 | },
76 | yuidoc: {
77 | fullpath: path.join(__dirname, 'yuidoc.js')
78 | },
79 | 'doc-builder': {
80 | fullpath: path.join(__dirname, 'builder.js'),
81 | requires: ['parallel', 'handlebars']
82 | },
83 | utils: {
84 | fullpath: path.join(__dirname, 'utils.js')
85 | },
86 | files: {
87 | fullpath: path.join(__dirname, 'files.js')
88 | },
89 | docview: {
90 | fullpath: path.join(__dirname, 'docview.js')
91 | },
92 | server: {
93 | fullpath: path.join(__dirname, 'server.js')
94 | },
95 | project: {
96 | fullpath: path.join(__dirname, 'project.js')
97 | }
98 | },
99 | logExclude: {
100 | attribute: true,
101 | handlebars: true
102 | },
103 | useSync: true
104 | }).use('utils', 'docparser', 'yuidoc', 'doc-builder', 'docview', 'files', 'help', 'options', 'server', 'project');
105 |
106 | Y.packageInfo = Y.Files.getJSON(metaPath);
107 |
108 | module.exports = Y;
109 |
--------------------------------------------------------------------------------
/tests/input/inherit/examplemodule.js:
--------------------------------------------------------------------------------
1 | /**
2 | * This is my example module
3 | * @module ExampleModule
4 | * @example
5 | *
6 | * var bar;
7 | *
8 | */
9 |
10 | YUI.add('examplemodule', function (Y) {
11 | Y.namespace('mywidget');
12 |
13 | /**
14 | * Superclass description. This is a second line too.
15 | *
16 | * @constructor
17 | * @class SuperWidget
18 | * @extends Widget
19 | * @namespace mywidget
20 | * @example
21 | *
22 | * var bar;
23 | *
24 | */
25 | Y.mywidget.superwidget = Y.Base.create("mysuperwidget", Y.Widget, [], {
26 |
27 | /**
28 | * Supermethod description. This is a second line.
29 | *
30 | * @method myMethod
31 | * @async
32 | */
33 | myMethod: function () {}
34 |
35 | /**
36 | * Overwritten method see {{#crossLink "mywidget.SuperWidget"}}{{/crossLink}}
37 | * also see {{#crossLink "mywidget.SuperWidget/myMethod"}}{{/crossLink}}
38 | * This is also a test {{#davglass "Foo"}}{{/davglass}}
39 | * @method getTargets2
40 | * @example
41 | *
42 | * var bar;
43 | *
44 | */
45 |
46 | /**
47 | * Overwritten method see {{#crossLink "mywidget.SuperWidget"}}{{/crossLink}}
48 | * also see {{#crossLink "mywidget.SuperWidget/myMethod"}}{{/crossLink}}
49 | * This is also a test {{#davglass "Foo"}}{{/davglass}}
50 | *
51 | * ```javascript
52 | *
53 | * var test = "hello from a code block!";
54 | *
55 | * ```
56 | *
57 | * @method getTargets3
58 | * @example
59 | *
60 | * var bar;
61 | *
62 | */
63 |
64 | /**
65 | * Override Attribute
66 | * @attribute focused2
67 | * @optional
68 | */
69 |
70 | /**
71 | * Override Attribute
72 | * @attribute focused3
73 | * @required
74 | */
75 |
76 | /**
77 | * Override Property
78 | * @property name2
79 | * @type String
80 | */
81 |
82 | /**
83 | * Override Event
84 | * @event init2
85 | */
86 |
87 | }, {
88 |
89 | });
90 |
91 | /**
92 | * Subclass description.
93 | *
94 | * @constructor
95 | * @namespace mywidget
96 | * @class SubWidget
97 | * @extends mywidget.SuperWidget
98 | */
99 | Y.mywidget.superwidget = Y.Base.create("mysuperwidget", Y.mywidget.superwidget, [], {
100 |
101 | /**
102 | * Submethod description.
103 | *
104 | * @method myMethod
105 | * @param {boolean} d Foo
106 | */
107 | myMethod: function () {}
108 |
109 | }, {
110 |
111 | });
112 |
113 | /**
114 | * Subclass description.
115 | *
116 | * @constructor
117 | * @namespace mywidget
118 | * @class SubWidget2
119 | * @extends Accordion
120 | */
121 | });
122 |
--------------------------------------------------------------------------------
/docs/themes/index.mustache:
--------------------------------------------------------------------------------
1 |
2 | YUIDoc uses Handlebars.js to render its templates.
3 | For easy customization, YUIDoc's default templates provide a specific set of file overrides.
4 |
5 |
6 |
Directories
7 |
8 |
9 | The default theme consists of `assets/`, `layouts/` and `partials/` directories,
10 | along with a `theme.json` file that describes theme-related variables,
11 | such as the JS and CSS to load.
12 |
29 | A YUIDoc template has two primary layout files: `main.handlebars` and `xhr.handlebars`.
30 |
31 |
32 |
33 |
34 |
`main`
35 |
36 | Provides a complete wrapper around every rendered page.
37 | `main.handlebars` includes the full HTML header and footer markup, CSS, and JS
38 | for every YUIDoc API page.
39 |
40 |
41 |
42 |
`xhr`
43 |
44 | Provides a smaller layout for the built-in doc server to use when requesting an individual page via XHR.
45 | This enables the browser to refresh just the content pane and avoid loading the complete markup for the entire page.
46 | The `xhr` template enables YUIDoc to progressively enhance the API documentation in an efficient manner.
47 |
48 |
49 |
50 |
51 |
Partials
52 |
53 |
54 | For each section of the layout that derives from parsed YUIDoc comment data,
55 | YUIDoc provides a Handlebars partial.
56 |
57 |
58 |
59 |
60 |
`index`
61 |
Renders the main index content.
62 |
63 |
64 |
`sidebar`
65 |
Renders the tabview containing the lists of classes and modules.
66 |
67 |
68 |
`options`
69 |
Renders the filter options at the top of the page, which enable the user to hide and show private methods, inherited methods, and so on.
70 |
71 |
72 |
`attrs`
73 |
Renders documentation for an individual YUI Attribute.
74 |
75 |
76 |
`classes`
77 |
Renders documentation for an individual class.
78 |
79 |
80 |
`events`
81 |
Renders documentation for an individual event.
82 |
83 |
84 |
`files`
85 |
Renders the API's source files.
86 |
87 |
88 |
`method`
89 |
Renders documentation for an individual method.
90 |
91 |
92 |
`module`
93 |
Renders documentation for an individual module.
94 |
95 |
96 |
`props`
97 |
Renders documentation for an individual property.
98 |
99 |
100 |
101 |
102 |
Overriding a Partial/Layout
103 |
104 |
105 | YUIDoc's `--themedir` option specifies a directory containing
106 | layouts and partials that override the default theme. For example:
107 |
114 | causes YUIDoc to inspect the directory `./mytheme` for template overrides.
115 | If this directory contains an override such as `./mytheme/partials/method.handlebars`,
116 | YUI will parse its internal templates first, then apply the custom `method.handlebars` partial.
117 | If a theme has no explicit override for a given template file,
118 | YUIDoc simply falls back to using the default layout or partial.
119 |
Color of the fill. The default value is determined by the order of the series on the graph. The color
76 | * will be retrieved from the below array:
77 | * `["#6084d0", "#eeb647", "#6c6b5f", "#d6484f", "#ce9ed1", "#ff9f3b", "#93b7ff", "#e0ddd0", "#94ecba", "#309687"]`
78 | *
79 | *
alpha
Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.
80 | *
81 | *
82 | *
border
A hash containing the following values:
83 | *
84 | *
color
Color of the border. The default value is determined by the order of the series on the graph. The color
85 | * will be retrieved from the below array:
86 | * `["#205096", "#b38206", "#000000", "#94001e", "#9d6fa0", "#e55b00", "#5e85c9", "#adab9e", "#6ac291", "#006457"]`
87 | *
alpha
Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.
88 | *
weight
Number indicating the width of the border. The default value is 1.
89 | *
90 | *
91 | *
width
indicates the width of the marker. The default value is 10.
92 | *
height
indicates the height of the marker The default value is 10.
93 | *
over
hash containing styles for markers when highlighted by a `mouseover` event. The default
94 | * values for each style is null. When an over style is not set, the non-over value will be used. For example,
95 | * the default value for `marker.over.fill.color` is equivalent to `marker.fill.color`.
84 | Fires when the value for the configuration attribute `{{{name}}}` is
85 | changed. You can listen for the event using the `on` method if you
86 | wish to be notified before the attribute's value has changed, or
87 | using the `after` method if you wish to be notified after the
88 | attribute's value has changed.
89 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
183 |
184 |
185 |
186 |
--------------------------------------------------------------------------------
/tests/input/test/test.js:
--------------------------------------------------------------------------------
1 |
2 | /**
3 | * The test project
4 | * @project tester
5 | * @title The Tester
6 | * @icon http://a.img
7 | * @url http://one.url
8 | * @url http://two.url
9 | * @author admo
10 | * @contributor davglass
11 | * @contributor entropy
12 | */
13 |
14 | /**
15 | * The module
16 | * @module mymodule
17 | * @category one,two
18 | * @category three
19 | * @requires one
20 | * @requires two
21 | * @uses three
22 | * @uses four
23 | */
24 |
25 | /**
26 | * The submodule
27 | * @submodule mysubmodule
28 | * @category three,four
29 | */
30 |
31 |
32 | /**
33 | * The class def
34 | * @class myclass
35 | * @constructor
36 | */
37 |
38 | /**
39 | * test optional
40 | * @method testoptional
41 | * @param notype my desc
42 | * @param {int} namesecond my desc
43 | * @param namefirst {string} my desc
44 | * @param [optionalvar] {bool} my desc
45 | * @param {string} [optionalwithdefault="defaultval"] my desc
46 | * @evil
47 | * @injects {HTML} uses a string parameter to populate innerHTML
48 | * @returns something without a type
49 | * @example
50 | * This is code
51 | * @example
52 | * var = 'This is more code';
53 | * document.title = 'Test This';
54 | */
55 |
56 | /**
57 | * test object param
58 | * @method testobjectparam
59 | * @param {object} anobject the object
60 | * @param {string} anobject.prop1 prop1
61 | * @param {bool} anobject.prop2 prop2
62 | * @return {string} something with a type
63 | */
64 |
65 | /**
66 | * test 0..n param
67 | * @method test0ton
68 | * @param {string} [optionalandmultiple]* my desc
69 | * @returns something without a type
70 | */
71 |
72 | /**
73 | * test 1..n param
74 | * @method test1ton
75 | * @param {string} multiple* my desc
76 | * @returns something without a type
77 | */
78 |
79 | /**
80 | * Testing really long param description paring
81 | * @method reallyLongParamDesc
82 | * @param {Object} config Object with configuration property name/value pairs. The object can be
83 | * used to provide default values for the objects published attributes.
84 | *
85 | *
86 | * The config object can also contain the following non-attribute properties, providing a convenient
87 | * way to configure events listeners and plugins for the instance, as part of the constructor call:
88 | *
89 | *
90 | *
91 | *
on
92 | *
An event name to listener function map, to register event listeners for the "on" moment of the event. A constructor convenience property for the on method.
93 | *
after
94 | *
An event name to listener function map, to register event listeners for the "after" moment of the event. A constructor convenience property for the after method.
95 | *
bubbleTargets
96 | *
An object, or array of objects, to register as bubble targets for bubbled events fired by this instance. A constructor convenience property for the addTarget method.
97 | *
plugins
98 | *
A plugin, or array of plugins to be plugged into the instance (see PluginHost's plug method for signature details). A constructor convenience property for the plug method.
99 | *
100 | *
101 | */
102 |
103 |
104 | /**
105 | This is the description
106 |
107 | @method foo
108 | @example
109 |
110 | var email = "lsmith@foo-truncated-here.com"
111 |
112 | **/
113 |
114 | /**
115 | Other Class
116 | @class OtherClass
117 | @extensionfor myclass
118 | */
119 |
120 | /**
121 | Other Class 2
122 | @class OtherClass2
123 | @extension_for myclass
124 | */
125 |
126 | /**
127 | Default options to use for all transactions.
128 | @static
129 | @protected
130 | @property {Object} options
131 | @property {Object} [options.attributes] HTML attribute name/value pairs that
132 | should be added to inserted nodes.
133 | @property {Boolean} [options.autopurge=false] Whether or not to automatically
134 | purge inserted nodes after the purge threshold is reached.
135 | @property {Document} [options.doc] Document into which nodes should be inserted.
136 | @property {Number} [options.pollInterval=50] Polling interval (in milliseconds)
137 | for detecting CSS load completion in browsers that don't support the `load`
138 | event on `` nodes.
139 | **/
140 |
141 |
142 | /**
143 | This is a test of CASE TaGs
144 | @MeThod testMethod
145 | @ParaM {String} foo Foo description
146 | */
147 |
148 | /**
149 | This is an optional attribute
150 | @attribute optionalAttr
151 | @optional
152 | */
153 |
154 | /**
155 | This is a required attribute
156 | @attribute requiredAttr
157 | @required
158 | */
159 |
160 | /**
161 | crash test method
162 | @method crashTest
163 | @params {String} foo The string to crash the parser
164 | */
165 |
166 | /**
167 | * @event changeWithOptional
168 | * @param ev {EventFacade} containing:
169 | * @param [ev.name] {String} Name of the field changed
170 | */
171 |
172 |
173 |
174 | /**
175 | This method fires {{#crossLink "OtherClass2/changeWithOptional:event"}}{{/crossLink}}
176 | @method crossedEvent
177 | */
178 |
179 | /**
180 | This method has attr {{#crossLink "OtherClass2/requiredAttr:attribute"}}{{/crossLink}}
181 | @method crossedAttr
182 | */
183 |
184 | /**
185 | This method has attr {{#crossLink "OtherClass2/optionalAttr:attr"}}{{/crossLink}}
186 | @method crossOptAttr
187 | */
188 |
189 | /**
190 | Test `\{{foobar\}}` `\{{barfoo\}}`
191 | @method hbHelper1
192 | */
193 |
194 | /**
195 | Test `\{{foobar2\}}` `\{{barfoo2\}}`
196 | @method hbHelper2
197 | */
198 |
199 | /**
200 | Test `\{{foobar3\}}` `\{{barfoo3\}}`
201 | @method hbHelper3
202 | */
203 |
204 |
--------------------------------------------------------------------------------
/lib/options.js:
--------------------------------------------------------------------------------
1 | YUI.add('options', function (Y) {
2 |
3 | var path = require('path');
4 |
5 | /**
6 | * Handles argument parsing
7 | * @module yuidoc
8 | * @class Options
9 | */
10 |
11 | /**
12 | * Parses arguments and returns an Object of config options
13 | * @method Options
14 | * @param {Array} args Arguments to parse
15 | * @return {Object} The config object
16 | */
17 | Y.Options = function (args) {
18 | /*jshint onevar:false */
19 |
20 | var options = {
21 | port: 3000,
22 | nocode: false
23 | };
24 |
25 | while (args.length > 0) {
26 | var v = args.shift();
27 | // options.* defined in ./builder.js
28 | switch (v) {
29 | case '--lint':
30 | options.lint = true;
31 | options.parseOnly = true;
32 | options.writeJSON = false;
33 | options.quiet = true;
34 | break;
35 | case "--debug":
36 | Y.applyConfig({
37 | debug: true,
38 | filter: 'debug'
39 | });
40 | break;
41 | case "--charset":
42 | Y.charset = args.shift() || 'utf8';
43 | Y.log('Setting default charset to ' + Y.charset, 'yuidoc', 'warn');
44 | break;
45 | case "-c":
46 | case "--config":
47 | case "--configfile":
48 | options.configfile = args.shift();
49 | break;
50 | case "-e":
51 | case "--extension":
52 | options.extension = args.shift();
53 | break;
54 | case "-x":
55 | case "--exclude":
56 | options.exclude = args.shift();
57 | break;
58 | case "-v":
59 | case "--version":
60 | console.error(Y.packageInfo.version);
61 | process.exit(1);
62 | break;
63 | case "--project-version":
64 | options.version = args.shift();
65 | break;
66 | case "-N":
67 | case "--no-color":
68 | Y.config.useColor = false;
69 | options.nocolor = true;
70 | break;
71 | case "-D":
72 | case "--no-delete-out":
73 | options.nodeleteout = true;
74 | break;
75 | case "-C":
76 | case "--no-code":
77 | options.nocode = true;
78 | break;
79 | case "-n":
80 | case "--norecurse":
81 | options.norecurse = true;
82 | break;
83 | case "-S":
84 | case "--selleck":
85 | options.selleck = true;
86 | break;
87 | case "-V":
88 | case "--view":
89 | options.dumpview = true;
90 | break;
91 | case "-p":
92 | case "--parse-only":
93 | options.parseOnly = true;
94 | break;
95 | case "-o":
96 | case "--outdir":
97 | options.outdir = args.shift();
98 | break;
99 | case "-t":
100 | case "--themedir":
101 | options.themedir = args.shift();
102 | break;
103 | case "--server":
104 | options.server = true;
105 | var a = args.shift();
106 | var p = parseInt(a, 10);
107 | if (isNaN(p) || !p) {
108 | if (a) {
109 | args.unshift(a);
110 | }
111 | Y.log('Failed to extract port, setting to the default :3000', 'warn', 'yuidoc');
112 | } else {
113 | options.port = p;
114 | }
115 | break;
116 | case "-h":
117 | case "--help":
118 | Y.showHelp();
119 | break;
120 | case "-H":
121 | case "--helpers":
122 | var list = args.shift();
123 | if (list) {
124 | options.helpers = list.split(',');
125 | } else {
126 | throw ('Failed to pass a helper file.');
127 | }
128 | break;
129 | case "-T":
130 | case "--theme":
131 | var theme = args.shift();
132 | options.themedir = path.join(__dirname, '../', 'themes', theme);
133 | break;
134 | case "-q":
135 | case "--quiet":
136 | options.quiet = true;
137 | break;
138 | case "--syntaxtype":
139 | options.syntaxtype = args.shift();
140 | break;
141 | case "--tab-to-space":
142 | options.tabtospace = parseInt(args.shift(), 10);
143 | if (typeof options.tabtospace === 'number') {
144 | options.tabspace = '';
145 | for (var s = 0; s < options.tabtospace; s++) {
146 | options.tabspace += ' ';
147 | }
148 | }
149 | break;
150 | default:
151 | if (!options.paths) {
152 | options.paths = [];
153 | }
154 | if (v && v.indexOf('-') === 0) {
155 | throw ('Unknown option: ' + v);
156 | }
157 | options.paths.push(v);
158 | }
159 | }
160 |
161 | if (options.quiet) {
162 | Y.applyConfig({
163 | debug: false
164 | });
165 | }
166 |
167 | return options;
168 | };
169 |
170 | });
171 |
--------------------------------------------------------------------------------
/output/api/classes/Main.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Main - yuidoc-root
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
Module creates the YUI instance with the required modules, uses them and exports the Y to be used
132 | by the CLI class or by extenders: require('yuidocjs'); You can use it like this:
133 |
var options = {
134 | paths: [ './lib' ],
135 | outdir: './out'
136 | };
137 |
138 | var Y = require('yuidocjs');
139 | var json = (new Y.YUIDoc(options)).run();
{{title}}
15 | 
{{title}}
50 |