File Index
24 | 25 |{+new Link().toSrc(item.alias).withText(item.name)+}
28 |-
30 |
- Author: 32 |
- {+item.author+} 33 |
- Version: 36 |
- {+item.version+} 37 |
- Location: 41 |
- {+location+} 43 |
48 |
├── .gitignore ├── CHANGELOG.md ├── Jakefile.js ├── LICENSE ├── README.md ├── docs ├── generate.sh ├── generated │ ├── files.html │ ├── index.html │ └── symbols │ │ ├── UndoManager.CircularStack.html │ │ ├── UndoManager.html │ │ ├── _global_.html │ │ ├── mindmaps.ApplicationController.html │ │ ├── mindmaps.CanvasContainer.Event.html │ │ ├── mindmaps.CanvasContainer.html │ │ ├── mindmaps.CanvasPresenter.html │ │ ├── mindmaps.CanvasView.html │ │ ├── mindmaps.ClipboardController.html │ │ ├── mindmaps.CloseDocumentCommand.html │ │ ├── mindmaps.Command.Event.html │ │ ├── mindmaps.Command.html │ │ ├── mindmaps.CommandRegistry.html │ │ ├── mindmaps.CopyNodeCommand.html │ │ ├── mindmaps.CreateNodeCommand.html │ │ ├── mindmaps.CutNodeCommand.html │ │ ├── mindmaps.DefaultCanvasView-CaptionEditor.html │ │ ├── mindmaps.DefaultCanvasView-Creator.html │ │ ├── mindmaps.DefaultCanvasView-TextMetrics.html │ │ ├── mindmaps.DefaultCanvasView.html │ │ ├── mindmaps.DeleteNodeCommand.html │ │ ├── mindmaps.Document.html │ │ ├── mindmaps.EditNodeCaptionCommand.html │ │ ├── mindmaps.Event.html │ │ ├── mindmaps.EventBus.html │ │ ├── mindmaps.FloatPanel.html │ │ ├── mindmaps.FloatPanelFactory.html │ │ ├── mindmaps.HelpCommand.html │ │ ├── mindmaps.HelpController.html │ │ ├── mindmaps.InspectorPresenter.html │ │ ├── mindmaps.InspectorView.html │ │ ├── mindmaps.LocalDocumentStorage.html │ │ ├── mindmaps.MainViewController.html │ │ ├── mindmaps.MindMap.html │ │ ├── mindmaps.MindMapModel.html │ │ ├── mindmaps.NavigatorPresenter.html │ │ ├── mindmaps.NavigatorView.html │ │ ├── mindmaps.NewDocumentCommand.html │ │ ├── mindmaps.NewDocumentPresenter.html │ │ ├── mindmaps.NewDocumentView.html │ │ ├── mindmaps.Node.html │ │ ├── mindmaps.NodeMap.html │ │ ├── mindmaps.Notification.html │ │ ├── mindmaps.OpenDocumentCommand.html │ │ ├── mindmaps.OpenDocumentPresenter.html │ │ ├── mindmaps.OpenDocumentView.html │ │ ├── mindmaps.PasteNodeCommand.html │ │ ├── mindmaps.Point.html │ │ ├── mindmaps.RedoCommand.html │ │ ├── mindmaps.SaveDocumentCommand.html │ │ ├── mindmaps.SaveDocumentPresenter.html │ │ ├── mindmaps.SaveDocumentView.html │ │ ├── mindmaps.ShortcutController.html │ │ ├── mindmaps.StatusBarPresenter.html │ │ ├── mindmaps.StatusBarView.html │ │ ├── mindmaps.StatusNotificationController.html │ │ ├── mindmaps.ToggleNodeFoldedCommand.html │ │ ├── mindmaps.ToolBarButton.html │ │ ├── mindmaps.ToolBarMenu.html │ │ ├── mindmaps.ToolBarPresenter.html │ │ ├── mindmaps.ToolBarView.html │ │ ├── mindmaps.UndoCommand.html │ │ ├── mindmaps.UndoController.html │ │ ├── mindmaps.Util.html │ │ ├── mindmaps.ZoomController.html │ │ ├── mindmaps.action.Action.html │ │ ├── mindmaps.action.ChangeNodeCaptionAction.html │ │ ├── mindmaps.action.ChangeNodeFontSizeAction.html │ │ ├── mindmaps.action.CloseNodeAction.html │ │ ├── mindmaps.action.CreateAutoPositionedNodeAction.html │ │ ├── mindmaps.action.CreateNodeAction.html │ │ ├── mindmaps.action.DecreaseNodeFontSizeAction.html │ │ ├── mindmaps.action.DeleteNodeAction.html │ │ ├── mindmaps.action.IncreaseNodeFontSizeAction.html │ │ ├── mindmaps.action.MoveNodeAction.html │ │ ├── mindmaps.action.OpenNodeAction.html │ │ ├── mindmaps.action.SetBranchColorAction.html │ │ ├── mindmaps.action.SetFontColorAction.html │ │ ├── mindmaps.action.SetFontDecorationAction.html │ │ ├── mindmaps.action.SetFontStyleAction.html │ │ ├── mindmaps.action.SetFontWeightAction.html │ │ ├── mindmaps.action.ToggleNodeFoldAction.html │ │ ├── mindmaps.action.html │ │ ├── mindmaps.html │ │ └── src │ │ ├── src_js_Action.js.html │ │ ├── src_js_ApplicationController.js.html │ │ ├── src_js_CanvasPresenter.js.html │ │ ├── src_js_CanvasView.js.html │ │ ├── src_js_ClipboardController.js.html │ │ ├── src_js_Command.js.html │ │ ├── src_js_CommandRegistry.js.html │ │ ├── src_js_Document.js.html │ │ ├── src_js_Event.js.html │ │ ├── src_js_FloatPanel.js.html │ │ ├── src_js_HelpController.js.html │ │ ├── src_js_Inspector.js.html │ │ ├── src_js_MainViewController.js.html │ │ ├── src_js_MindMap.js.html │ │ ├── src_js_MindMapModel.js.html │ │ ├── src_js_MindMaps.js.html │ │ ├── src_js_Navigator.js.html │ │ ├── src_js_NewDocument.js.html │ │ ├── src_js_Node.js.html │ │ ├── src_js_NodeMap.js.html │ │ ├── src_js_Notification.js.html │ │ ├── src_js_OpenDocument.js.html │ │ ├── src_js_Point.js.html │ │ ├── src_js_SaveDocument.js.html │ │ ├── src_js_ShortcutController.js.html │ │ ├── src_js_StatusBar.js.html │ │ ├── src_js_Storage.js.html │ │ ├── src_js_ToolBar.js.html │ │ ├── src_js_UndoController.js.html │ │ ├── src_js_UndoManager.js.html │ │ ├── src_js_Util.js.html │ │ └── src_js_ZoomController.js.html └── node-jsdoc-toolkit │ ├── README.txt │ ├── app │ ├── frame.js │ ├── frame │ │ ├── Chain.js │ │ ├── Dumper.js │ │ ├── Hash.js │ │ ├── Link.js │ │ ├── Namespace.js │ │ ├── Opt.js │ │ ├── Reflection.js │ │ ├── String.js │ │ └── Testrun.js │ ├── handlers │ │ ├── FOODOC.js │ │ ├── XMLDOC.js │ │ └── XMLDOC │ │ │ ├── DomReader.js │ │ │ ├── XMLDoc.js │ │ │ └── XMLParse.js │ ├── lib │ │ ├── JSDOC.js │ │ └── JSDOC │ │ │ ├── DocComment.js │ │ │ ├── DocTag.js │ │ │ ├── JsDoc.js │ │ │ ├── JsPlate.js │ │ │ ├── Lang.js │ │ │ ├── Parser.js │ │ │ ├── PluginManager.js │ │ │ ├── Symbol.js │ │ │ ├── SymbolSet.js │ │ │ ├── TextStream.js │ │ │ ├── Token.js │ │ │ ├── TokenReader.js │ │ │ ├── TokenStream.js │ │ │ ├── Util.js │ │ │ └── Walker.js │ ├── main.js │ ├── plugins │ │ ├── commentSrcJson.js │ │ ├── frameworkPrototype.js │ │ ├── functionCall.js │ │ ├── publishSrcHilite.js │ │ ├── symbolLink.js │ │ ├── tagParamConfig.js │ │ └── tagSynonyms.js │ ├── run.js │ ├── t │ │ ├── TestDoc.js │ │ └── runner.js │ ├── test.js │ └── test │ │ ├── addon.js │ │ ├── anon_inner.js │ │ ├── augments.js │ │ ├── augments2.js │ │ ├── borrows.js │ │ ├── borrows2.js │ │ ├── config.js │ │ ├── constructs.js │ │ ├── encoding.js │ │ ├── encoding_other.js │ │ ├── event.js │ │ ├── exports.js │ │ ├── functions_anon.js │ │ ├── functions_nested.js │ │ ├── global.js │ │ ├── globals.js │ │ ├── ignore.js │ │ ├── inner.js │ │ ├── jsdoc_test.js │ │ ├── lend.js │ │ ├── memberof.js │ │ ├── memberof2.js │ │ ├── memberof3.js │ │ ├── memberof_constructor.js │ │ ├── module.js │ │ ├── multi_methods.js │ │ ├── name.js │ │ ├── namespace_nested.js │ │ ├── nocode.js │ │ ├── oblit_anon.js │ │ ├── overview.js │ │ ├── param_inline.js │ │ ├── params_optional.js │ │ ├── prototype.js │ │ ├── prototype_nested.js │ │ ├── prototype_oblit.js │ │ ├── prototype_oblit_constructor.js │ │ ├── public.js │ │ ├── scripts │ │ ├── code.js │ │ └── notcode.txt │ │ ├── shared.js │ │ ├── shared2.js │ │ ├── shortcuts.js │ │ ├── static_this.js │ │ ├── synonyms.js │ │ ├── tosource.js │ │ └── variable_redefine.js │ ├── changes.txt │ ├── conf │ └── default.conf │ └── templates │ └── jsdoc │ ├── allclasses.tmpl │ ├── allfiles.tmpl │ ├── class.tmpl │ ├── index.tmpl │ ├── publish.js │ ├── static │ ├── default.css │ ├── header.html │ └── index.html │ └── symbol.tmpl ├── package-lock.json ├── package.json ├── psd ├── creator-nub.psd ├── favicon.psd └── plus-minus.psd ├── src ├── about.html ├── cache.appcache ├── css │ ├── Aristo │ │ ├── images │ │ │ ├── bg_fallback.png │ │ │ ├── icon_sprite.png │ │ │ ├── progress_bar.gif │ │ │ ├── slider_handles.png │ │ │ ├── ui-icons_222222_256x240.png │ │ │ └── ui-icons_454545_256x240.png │ │ └── jquery-ui-1.8.7.custom.css │ ├── about.css │ ├── app.css │ ├── common.css │ └── minicolors │ │ ├── images │ │ ├── circle.gif │ │ ├── gradient.png │ │ ├── line.gif │ │ ├── rainbow.png │ │ └── trigger.png │ │ └── jquery.miniColors.css ├── img │ ├── ajax-loader.gif │ ├── closedhand.png │ ├── creator-nub-sprite.png │ ├── favicon.png │ ├── grid.gif │ ├── openhand.png │ └── plus-minus.png ├── index.html └── js │ ├── Action.js │ ├── ApplicationController.js │ ├── AutoSaveController.js │ ├── CanvasDrawingTools.js │ ├── CanvasPresenter.js │ ├── CanvasView.js │ ├── ClipboardController.js │ ├── Command.js │ ├── CommandRegistry.js │ ├── Document.js │ ├── Event.js │ ├── ExportMap.js │ ├── FilePicker.js │ ├── FloatPanel.js │ ├── HelpController.js │ ├── Inspector.js │ ├── MainViewController.js │ ├── MindMap.js │ ├── MindMapModel.js │ ├── MindMaps.js │ ├── Navigator.js │ ├── NewDocument.js │ ├── Node.js │ ├── NodeMap.js │ ├── Notification.js │ ├── OpenDocument.js │ ├── Point.js │ ├── PrintController.js │ ├── SaveDocument.js │ ├── ShortcutController.js │ ├── StaticCanvas.js │ ├── StatusBar.js │ ├── Storage.js │ ├── ToolBar.js │ ├── UndoController.js │ ├── UndoManager.js │ ├── Util.js │ ├── ZoomController.js │ └── libs │ ├── dragscrollable.js │ ├── events.js │ ├── jquery-ui-1.8.11.custom.complete.min.js │ ├── jquery-ui-1.8.11.custom.min.js │ ├── jquery.hotkeys.js │ ├── jquery.minicolors.js │ ├── jquery.mousewheel.js │ └── jquery.tmpl.js └── test ├── jasmine ├── CommandSpec.js ├── DocumentSpec.js ├── IntegrationTestSpec.js ├── MindMapSpec.js ├── NodeMapSpec.js ├── NodeSpec.js ├── PointSpec.js ├── SpecHelper.js ├── SpecRunner.html ├── StorageSpec.js ├── UndoManagerSpec.js └── jasmine-1.1.0 │ ├── MIT.LICENSE │ ├── jasmine-html.js │ ├── jasmine.css │ ├── jasmine.js │ └── jasmine_favicon.png └── selenium ├── dependencies.txt └── src ├── helper └── SeleniumHelper.java └── tests ├── BaseMindMapsTestCase.java ├── BasicFunctions.java └── LoadTests.java /.gitignore: -------------------------------------------------------------------------------- 1 | .settings/ 2 | .project 3 | .classpath 4 | dist/ 5 | node_modules/ 6 | .idea 7 | .vscode/ -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## 2012-06-24 4 | - Added integration with Dropbox and other cloud storage services (finally!) 5 | 6 | ## 2012-04-25 7 | - Added feature to set the branch color of all children to the parent's color 8 | - Branch and font color changes now happen on-the-fly when using the colorpicker 9 | 10 | ## 2012-02-13 11 | - Added auto save feature for LocalStorage 12 | 13 | ## 2012-01-21 14 | - Added Shortcuts for Mac OSX users 15 | 16 | ## 2011-08-09 17 | - Implemented PNG export 18 | - Added support for printing the mind map 19 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PSA: This project is not actively maintained. I consider it feature complete for what it set out to do. I'll fix critical bugs should they pop up but I won't be adding new features. 2 | 3 | 4 | # mindmaps 5 | mindmaps is a HTML5 based mind mapping application. It lets you create neat looking mind maps in the browser. 6 | 7 | This project started in 2011 as an exploration into what's possible to do in browsers using modern APIs. Nowadays, most of this stuff is pretty common and the code base is a bit outdated. This was way before React, ES6, webpack. Heck, it doesn't even use Backbone. 8 | 9 | However, there is no reason to change any of that and it makes the code base quite easy to grok. There is no compilation step, no babel plugins, no frameworks. Just a JavaScript application and a very simple Model-View-Presenter pattern. 10 | 11 | ## HTML5 stuff which was cool in 2011 12 | - 100% offline capable via ApplicationCache 13 | - Stores mind maps in LocalStorage 14 | - FileReader API reads stored mind maps from the hard drive 15 | - Canvas API draws the mind map 16 | 17 | ## Try it out 18 | The latest stable build is hosted [here](https://www.mindmaps.app). 19 | 20 | ## Build 21 | * First run `npm install` to install required dependencies 22 | * Run `npm run start` to launch a local dev server. The app will be hosted at [http://localhost:3000](http://localhost:3000). 23 | * Run `npm run build` to compile the production bundle. The artifacts will be located in `/dist`. 24 | 25 | 26 | ## Host yourself 27 | All you need is a web server for static files. After building, copy all files from /dist into your web directory and launch the app with index.html. 28 | Make sure your web server serves .appcache files with the mime type `text/cache-manifest` for the application to 29 | be accessible offline. 30 | 31 | In Apache add the following line to your .htaccess: 32 | 33 | ``` 34 | AddType text/cache-manifest .appcache 35 | ``` 36 | 37 | In nginx add this to conf/mime.types: 38 | 39 | ``` 40 | text/cache-manifest appcache; 41 | ``` 42 | 43 | Alternatively, you can launch a local debug server with `npm start` which starts a server on localhost:8080. 44 | 45 | ## License 46 | mindmaps is licensed under AGPL V3, see LICENSE for more information. 47 | -------------------------------------------------------------------------------- /docs/generate.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | echo "Generating project documentation..." 4 | script_dir=$(dirname $0) 5 | 6 | cd $script_dir/node-jsdoc-toolkit 7 | node app/run.js -c=conf/default.conf 8 | 9 | -------------------------------------------------------------------------------- /docs/generated/symbols/src/src_js_NewDocument.js.html: -------------------------------------------------------------------------------- 1 |
1 /** 9 | 2 * Unused for now. 10 | 3 * 11 | 4 * @constructor 12 | 5 */ 13 | 6 mindmaps.NewDocumentView = function() { 14 | 7 15 | 8 }; 16 | 9 17 | 10 /** 18 | 11 * Creates a new NewDocumentPresenter. This presenter has no view associated 19 | 12 * with it for now. It simply creates a new document. It could in the future 20 | 13 * display a dialog where the user could chose options like document title and 21 | 14 * such. 22 | 15 * 23 | 16 * @constructor 24 | 17 */ 25 | 18 mindmaps.NewDocumentPresenter = function(eventBus, mindmapModel, view) { 26 | 19 27 | 20 this.go = function() { 28 | 21 var doc = new mindmaps.Document(); 29 | 22 mindmapModel.setDocument(doc); 30 | 23 }; 31 | 24 };-------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/README.txt: -------------------------------------------------------------------------------- 1 | ====================================================================== 2 | 3 | DESCRIPTION: 4 | 5 | This is the source code for JsDoc Toolkit, an automatic documentation 6 | generation tool for JavaScript. It is written in JavaScript and is run 7 | from a command line (or terminal) using the Node.JS JavaScript runtime 8 | engine. 9 | 10 | Using this tool you can automatically turn JavaDoc-like comments in 11 | your JavaScript source code into published output files, such as HTML 12 | or XML. 13 | 14 | For more information, to report a bug, or to browse the technical 15 | documentation for this tool please visit the official JsDoc Toolkit 16 | project homepage at http://code.google.com/p/jsdoc-toolkit/ 17 | 18 | For the most up-to-date documentation on JsDoc Toolkit see the 19 | official wiki at http://code.google.com/p/jsdoc-toolkit/w/list 20 | 21 | ====================================================================== 22 | 23 | REQUIREMENTS: 24 | 25 | Node.JS interpreter http://nodejs.org 26 | 27 | ====================================================================== 28 | 29 | USAGE: 30 | 31 | Before running the JsDoc Toolkit app you should change your current 32 | working directory to the jsdoc-toolkit folder. Then follow the 33 | examples below, or as shown on the project wiki. 34 | 35 | On Mac OS X or Linux the command would look like this: 36 | 37 | $ app/run.js -a -t=templates/jsdoc mycode.js 38 | 39 | The above assumes your current working directory contains the "app" 40 | and "templates" subdirectories from the standard JsDoc Toolkit 41 | distribution and that the relative path to the code you wish to 42 | document is "mycode.js". 43 | 44 | The output documentation files will be saved to a new directory named 45 | "out" (by default) in the current directory, or if you specify a 46 | -d=somewhere_else option, to the somewhere_else directory. 47 | 48 | For help (usage notes) enter this on the command line: 49 | 50 | $ app/run.js --help 51 | 52 | More information about the various command line options used by JsDoc 53 | Toolkit are available on the project wiki. 54 | 55 | ====================================================================== 56 | 57 | TESTING: 58 | 59 | To run the suite of unit tests included with JsDoc Toolkit enter this 60 | on the command line: 61 | 62 | $ app/run.js -T 63 | 64 | To see a dump of the internal data structure that JsDoc Toolkit has 65 | built from your source files use this command: 66 | 67 | $ app/run.js mycode.js -Z 68 | 69 | ====================================================================== 70 | 71 | LICENSE: 72 | 73 | JSDoc.pm 74 | 75 | This project is based on the JSDoc.pm tool, created by Michael 76 | Mathews and Gabriel Reid. More information on JsDoc.pm can 77 | be found on the JSDoc.pm homepage: http://jsdoc.sourceforge.net/ 78 | 79 | Complete documentation on JsDoc Toolkit can be found on the project 80 | wiki at http://code.google.com/p/jsdoc-toolkit/w/list 81 | 82 | JsDoc Toolkit 83 | 84 | All code specific to JsDoc Toolkit are free, open source and licensed 85 | for use under the X11/MIT License. 86 | 87 | JsDoc Toolkit is Copyright (c)2009 Michael Mathews
4 | This is a lightly modified version of Kevin Jones' JavaScript 5 | library Data.Dump. To download the original visit: 6 | http://openjsan.org/doc/k/ke/kevinj/Data/Dump/ 7 | 8 | AUTHORS 9 | 10 | The Data.Dump JavaScript module is written by Kevin Jones 11 | (kevinj@cpan.org), based on Data::Dump by Gisle Aas (gisle@aas.no), 12 | based on Data::Dumper by Gurusamy Sarathy (gsar@umich.edu). 13 | 14 | COPYRIGHT 15 | 16 | Copyright 2007 Kevin Jones. Copyright 1998-2000,2003-2004 Gisle Aas. 17 | Copyright 1996-1998 Gurusamy Sarathy. 18 | 19 | This program is free software; you can redistribute it and/or modify 20 | it under the terms of the Perl Artistic License 21 | 22 | See http://www.perl.com/perl/misc/Artistic.html 23 |24 | * @static 25 | */ 26 | Dumper = { 27 | /** @param [...] The objects to dump. */ 28 | dump: function () { 29 | if (arguments.length > 1) 30 | return this._dump(arguments); 31 | else if (arguments.length == 1) 32 | return this._dump(arguments[0]); 33 | else 34 | return "()"; 35 | }, 36 | 37 | _dump: function (obj) { 38 | if (typeof obj == 'undefined') return 'undefined'; 39 | var out; 40 | if (obj.serialize) { return obj.serialize(); } 41 | var type = this._typeof(obj); 42 | if (obj.circularReference) obj.circularReference++; 43 | switch (type) { 44 | case 'circular': 45 | out = "{ //circularReference\n}"; 46 | break; 47 | case 'object': 48 | var pairs = new Array; 49 | 50 | for (var prop in obj) { 51 | if (prop != "circularReference" && obj.hasOwnProperty(prop)) { //hide inherited properties 52 | pairs.push(prop + ': ' + this._dump(obj[prop])); 53 | } 54 | } 55 | 56 | out = '{' + this._format_list(pairs) + '}'; 57 | break; 58 | 59 | case 'string': 60 | for (var prop in Dumper.ESC) { 61 | if (Dumper.ESC.hasOwnProperty(prop)) { 62 | obj = obj.replace(prop, Dumper.ESC[prop]); 63 | } 64 | } 65 | 66 | // Escape UTF-8 Strings 67 | if (obj.match(/^[\x00-\x7f]*$/)) { 68 | out = '"' + obj.replace(/\"/g, "\\\"").replace(/([\n\r]+)/g, "\\$1") + '"'; 69 | } 70 | else { 71 | out = "unescape('"+escape(obj)+"')"; 72 | } 73 | break; 74 | 75 | case 'array': 76 | var elems = new Array; 77 | 78 | for (var i=0; i
"; 50 | this.footer = ""; 51 | this.showLinenumbers = true; 52 | } 53 | 54 | JsHilite.cache = {}; 55 | 56 | JsHilite.prototype.hilite = function() { 57 | var hilited = this.tokens.join(""); 58 | var line = 1; 59 | if (this.showLinenumbers) hilited = hilited.replace(/(^|\n)/g, function(m){return m+""+((line<10)? " ":"")+((line<100)? " ":"")+(line++)+" "}); 60 | 61 | return this.header+hilited+this.footer; 62 | } -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/plugins/symbolLink.js: -------------------------------------------------------------------------------- 1 | JSDOC.PluginManager.registerPlugin( 2 | "JSDOC.symbolLink", 3 | { 4 | onSymbolLink: function(link) { 5 | // modify link.linkPath (the href part of the link) 6 | // or link.linkText (the text displayed) 7 | // or link.linkInner (the #name part of the link) 8 | } 9 | } 10 | ); -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/plugins/tagParamConfig.js: -------------------------------------------------------------------------------- 1 | JSDOC.PluginManager.registerPlugin( 2 | "JSDOC.tagParamConfig", 3 | { 4 | onDocCommentTags: function(comment) { 5 | var currentParam = null; 6 | var tags = comment.tags; 7 | for (var i = 0, l = tags.length; i < l; i++) { 8 | 9 | if (tags[i].title == "param") { 10 | if (tags[i].name.indexOf(".") == -1) { 11 | currentParam = i; 12 | } 13 | } 14 | else if (tags[i].title == "config") { 15 | tags[i].title = "param"; 16 | if (currentParam == null) { 17 | tags[i].name = "arguments"+"."+tags[i].name; 18 | } 19 | else if (tags[i].name.indexOf(tags[currentParam].name+".") != 0) { 20 | tags[i].name = tags[currentParam].name+"."+tags[i].name; 21 | } 22 | currentParam != null 23 | //tags[currentParam].properties.push(tags[i]); 24 | } 25 | else { 26 | currentParam = null; 27 | } 28 | } 29 | } 30 | } 31 | ); 32 | -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/plugins/tagSynonyms.js: -------------------------------------------------------------------------------- 1 | JSDOC.PluginManager.registerPlugin( 2 | "JSDOC.tagSynonyms", 3 | { 4 | onDocCommentSrc: function(comment) { 5 | comment.src = comment.src.replace(/@methodOf\b/i, "@function\n@memberOf"); 6 | comment.src = comment.src.replace(/@fieldOf\b/i, "@field\n@memberOf"); 7 | }, 8 | 9 | onDocCommentTags: function(comment) { 10 | for (var i = 0, l = comment.tags.length; i < l; i++) { 11 | var title = comment.tags[i].title.toLowerCase(); 12 | var syn; 13 | if ((syn = JSDOC.tagSynonyms.synonyms["="+title])) { 14 | comment.tags[i].title = syn; 15 | } 16 | } 17 | } 18 | } 19 | ); 20 | 21 | new Namespace( 22 | "JSDOC.tagSynonyms", 23 | function() { 24 | JSDOC.tagSynonyms.synonyms = { 25 | "=member": "memberOf", 26 | "=memberof": "memberOf", 27 | "=description": "desc", 28 | "=exception": "throws", 29 | "=argument": "param", 30 | "=returns": "return", 31 | "=classdescription": "class", 32 | "=fileoverview": "overview", 33 | "=extends": "augments", 34 | "=base": "augments", 35 | "=projectdescription": "overview", 36 | "=classdescription": "class", 37 | "=link": "see", 38 | "=borrows": "inherits", 39 | "=scope": "lends", 40 | "=construct": "constructor" 41 | } 42 | } 43 | ); -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/t/TestDoc.js: -------------------------------------------------------------------------------- 1 | var TestDoc = { 2 | fails: 0, 3 | plans: 0, 4 | passes: 0, 5 | results: [] 6 | }; 7 | 8 | TestDoc.record = function(result) { 9 | TestDoc.results.push(result); 10 | if (typeof result.verdict == "boolean") { 11 | if (result.verdict === false) TestDoc.fails++; 12 | if (result.verdict === true) TestDoc.passes++; 13 | } 14 | } 15 | 16 | TestDoc.prove = function(filePath) { 17 | if (typeof document != "undefined" && typeof document.write != "undefined") { 18 | if (TestDoc.console) print = function(s) { TestDoc.console.appendChild(document.createTextNode(s+"\n")); } 19 | else print = function(s) { document.write(s+"
6 | var x (x < 1); 7 | alert("This 'is' \"code\""); 8 |9 | * @name My Cool Library 10 | * @author Joe Smith jsmith@company.com 11 | * @version 0.1 12 | */ 13 | 14 | /** 15 | * Gets the current foo 16 | * @param {String} fooId The unique identifier for the foo. 17 | * @return {Object} Returns the current foo. 18 | */ 19 | function getFoo(fooID){ 20 | } -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/param_inline.js: -------------------------------------------------------------------------------- 1 | /** 2 | @constructor 3 | @param columns The number of columns. 4 | */ 5 | function Layout(/**int*/columns){ 6 | /** 7 | @param [id] The id of the element. 8 | @param elName The name of the element. 9 | */ 10 | this.getElement = function( 11 | /** string */ elName, 12 | /** number|string */ id 13 | ) { 14 | }; 15 | 16 | /** 17 | @constructor 18 | */ 19 | this.Canvas = function(top, left, /**int*/width, height) { 20 | /** Is it initiated yet? */ 21 | this.initiated = true; 22 | } 23 | 24 | this.rotate = function(/**nothing*/) { 25 | } 26 | 27 | /** 28 | @param x 29 | @param y 30 | @param {zoppler} z*/ 31 | this.init = function(x, y, /**abbler*/z) { 32 | /** The xyz. */ 33 | this.xyz = x+y+z; 34 | this.getXyz = function() { 35 | } 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/params_optional.js: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * @param {Page[]} pages 4 | * @param {number} [id] Specifies the id, if applicable. 5 | * @param {String} [title = This is untitled.] Specifies the title. 6 | */ 7 | function Document(pages, id, title){ 8 | } -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/prototype.js: -------------------------------------------------------------------------------- 1 | /** @constructor */ 2 | function Article() { 3 | } 4 | 5 | Article.prototype.init = function(title) { 6 | /** the instance title */ 7 | this.title = title; 8 | 9 | /** the static counter */ 10 | Article.counter = 1; 11 | } 12 | 13 | a = new Article(); 14 | a.Init("my title"); 15 | 16 | print(a.title); 17 | print(Article.counter); -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/prototype_nested.js: -------------------------------------------------------------------------------- 1 | /** @constructor */ 2 | function Word() { 3 | } 4 | 5 | Word.prototype.reverse = function() { 6 | } 7 | 8 | Word.prototype.reverse.utf8 = function() { 9 | } -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/prototype_oblit.js: -------------------------------------------------------------------------------- 1 | /** @constructor */ 2 | function Article() { 3 | } 4 | 5 | Article.prototype = { 6 | /** instance get title */ 7 | getTitle: function(){ 8 | } 9 | } 10 | 11 | /** static get title */ 12 | Article.getTitle = function(){ 13 | } -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/prototype_oblit_constructor.js: -------------------------------------------------------------------------------- 1 | /** @constructor */ 2 | function Article() { 3 | } 4 | 5 | Article.prototype = { 6 | /** @constructor */ 7 | Title: function(title) { 8 | /** the value of the Title instance */ 9 | this.title = title; 10 | }, 11 | 12 | init: function(pages) { 13 | /** the value of the pages of the Article instance */ 14 | this.pages = pages; 15 | } 16 | } 17 | 18 | f = new Article(); 19 | f.init("one two three"); 20 | 21 | t = new f.Title("my title"); 22 | 23 | print(f.pages); 24 | print(t.title); -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/public.js: -------------------------------------------------------------------------------- 1 | /**@constructor*/ 2 | function Foo() { 3 | /** 4 | @public 5 | @static 6 | @field 7 | */ 8 | var bar = function(x) { 9 | } 10 | } -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/scripts/code.js: -------------------------------------------------------------------------------- 1 | /** 2 | @class 3 | */ 4 | function thisiscode() { 5 | } -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/scripts/notcode.txt: -------------------------------------------------------------------------------- 1 | (This is not code) 2 | function foo(){{{{ 3 | ( 4 | ! 5 | @ -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/shared.js: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * Builtin object. 4 | * @class 5 | * @name Array 6 | */ 7 | 8 | /**#@+ 9 | * Extension to builtin array. 10 | * @memberOf Array 11 | * @method 12 | */ 13 | 14 | /** 15 | * @returns Boolen if some array members... 16 | */ 17 | Array.prototype.some = function(){}; 18 | 19 | /** 20 | * Change every element of an array. 21 | * @returns Filtered array copy. 22 | */ 23 | Array.prototype.filter = function(){}; 24 | 25 | /**#@-*/ 26 | 27 | 28 | /** 29 | * A first in, first out data structure. 30 | * @constructor 31 | */ 32 | Queue = function(){}; 33 | 34 | /**#@+ 35 | * Extension to Queue. 36 | * @memberOf Queue 37 | */ 38 | 39 | rewind = function(){ 40 | } 41 | 42 | // should close automatically here. -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/shared2.js: -------------------------------------------------------------------------------- 1 | startOver = function(){ 2 | } -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/shortcuts.js: -------------------------------------------------------------------------------- 1 | // /**#=+ 2 | // * { 3 | // * 'D': 'Date.prototype', 4 | // * '$N': 'Number' 5 | // * } 6 | // */ 7 | // var D = Date.prototype, 8 | // $N = Number; 9 | // 10 | // D.locale = function(){ 11 | // }; 12 | // 13 | // /** 14 | // @return {string} The cardinal number string. 15 | // */ 16 | // $N.nth = function(n){ 17 | // }; 18 | // 19 | // LOAD.file = function(){ 20 | // } 21 | // 22 | // /**#=-*/ -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/static_this.js: -------------------------------------------------------------------------------- 1 | /** the parent */ 2 | var box = {}; 3 | 4 | /** @namespace */ 5 | box.holder = {} 6 | 7 | box.holder.foo = function() { 8 | /** the counter */ 9 | this.counter = 1; 10 | } 11 | 12 | box.holder.foo(); 13 | print(box.holder.counter); 14 | -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/synonyms.js: -------------------------------------------------------------------------------- 1 | /** 2 | @class 3 | @inherits Bar#zop as #my_zop 4 | */ 5 | function Foo() { 6 | /** this is a zip. */ 7 | this.zip = function() {} 8 | 9 | /** from Bar */ 10 | this.my_zop = new Bar().zop; 11 | } 12 | 13 | /** 14 | @class 15 | @borrows Foo#zip as this.my_zip 16 | */ 17 | function Bar() { 18 | /** this is a zop. */ 19 | this.zop = function() {} 20 | 21 | /** from Foo */ 22 | this.my_zip = new Foo().zip; 23 | } 24 | 25 | /** @namespace */ 26 | var myObject = { 27 | /** 28 | @type function 29 | */ 30 | myFunc: getFunction() 31 | } -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/tosource.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @param {Object} object 3 | * @return {string} 4 | */ 5 | function valueOf(object) {} 6 | 7 | /** 8 | * @param {Object} object 9 | * @return {string} 10 | */ 11 | function toString(object) {} 12 | 13 | /** 14 | * @param {Object} object 15 | * @return {string} 16 | */ 17 | function toSource(object) {} 18 | 19 | /** 20 | * @param {Object} object 21 | * @return {string} 22 | */ 23 | function constructor(object) {} -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/app/test/variable_redefine.js: -------------------------------------------------------------------------------- 1 | /** @constructor */ 2 | function Foo() { 3 | var bar = 1; 4 | bar = 2; // redefining a private 5 | 6 | this.baz = 1; 7 | baz = 2; // global 8 | 9 | /** a private */ 10 | var blap = { 11 | /** in here */ 12 | tada: 1 13 | } 14 | } -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/conf/default.conf: -------------------------------------------------------------------------------- 1 | /* 2 | This is an example of one way you could set up a configuration file to more 3 | conveniently define some commandline options. You might like to do this if 4 | you frequently reuse the same options. Note that you don't need to define 5 | every option in this file, you can combine a configuration file with 6 | additional options on the commandline if your wish. 7 | 8 | You would include this configuration file by running JsDoc Toolkit like so: 9 | java -jar jsrun.jar app/run.js -c=conf/sample.conf 10 | 11 | */ 12 | 13 | { 14 | // source files to use 15 | _: ['../../src/js'], 16 | 17 | // document all functions, even uncommented ones 18 | a: false, 19 | 20 | // including those marked @private 21 | p: true, 22 | 23 | // some extra variables I want to include 24 | // D: {generatedBy: "Michael Mathews", copyright: "2008"}, 25 | 26 | // use this directory as the output directory 27 | d: "../generated", 28 | 29 | // use this template 30 | t: "templates/jsdoc" 31 | } -------------------------------------------------------------------------------- /docs/node-jsdoc-toolkit/templates/jsdoc/allclasses.tmpl: -------------------------------------------------------------------------------- 1 |