{"id":18742642,"url":"https://github.com/symphonycms/symphony-jsdoc","last_synced_at":"2025-11-21T04:30:17.634Z","repository":{"id":66510354,"uuid":"1947482","full_name":"symphonycms/symphony-jsdoc","owner":"symphonycms","description":null,"archived":false,"fork":false,"pushed_at":"2016-02-18T18:31:12.000Z","size":845,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":19,"default_branch":"master","last_synced_at":"2024-12-28T19:28:15.504Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/symphonycms.png","metadata":{"files":{"readme":"README.txt","changelog":"changes.txt","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-06-24T12:58:16.000Z","updated_at":"2016-02-05T19:50:53.000Z","dependencies_parsed_at":"2023-05-04T09:41:48.208Z","dependency_job_id":null,"html_url":"https://github.com/symphonycms/symphony-jsdoc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/symphonycms%2Fsymphony-jsdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/symphonycms%2Fsymphony-jsdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/symphonycms%2Fsymphony-jsdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/symphonycms%2Fsymphony-jsdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/symphonycms","download_url":"https://codeload.github.com/symphonycms/symphony-jsdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239622718,"owners_count":19670150,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T16:08:52.441Z","updated_at":"2025-11-21T04:30:17.529Z","avatar_url":"https://github.com/symphonycms.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"======================================================================\n\nDESCRIPTION:\n\nThis is the source code for JsDoc Toolkit, an automatic documentation\ngeneration tool for JavaScript. It is written in JavaScript and is run\nfrom a command line (or terminal) using Java and Mozilla's Rhino\nJavaScript runtime engine.\n\nUsing this tool you can automatically turn JavaDoc-like comments in\nyour JavaScript source code into published output files, such as HTML\nor XML.\n\nFor more information, to report a bug, or to browse the technical\ndocumentation for this tool please visit the official JsDoc Toolkit\nproject homepage at http://code.google.com/p/jsdoc-toolkit/\n\nFor the most up-to-date documentation on JsDoc Toolkit see the \nofficial wiki at http://code.google.com/p/jsdoc-toolkit/w/list\n\n======================================================================\n\nREQUIREMENTS:\n\nJsDoc Toolkit is known to work with:\njava version \"1.6.0_03\"\nJava(TM) SE Runtime Environment (build 1.6.0_03-b05)\non Windows XP,\nand java version \"1.5.0_19\"\nJava(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_19-b02-304)\non Mac OS X 10.5.\n\nOther versions of java may or may not work with JsDoc Toolkit.\n\n======================================================================\n\nUSAGE:\n\nRunning JsDoc Toolkit requires you to have Java installed on your\ncomputer. For more information see http://www.java.com/getjava/\n\nBefore running the JsDoc Toolkit app you should change your current\nworking directory to the jsdoc-toolkit folder. Then follow the\nexamples below, or as shown on the project wiki.\n\nOn a computer running Windows a valid command line to run JsDoc\nToolkit might look like this:\n\n\u003e java -jar jsrun.jar app\\run.js -a -t=templates\\jsdoc mycode.js\n\nOn Mac OS X or Linux the same command would look like this:\n\n$ java -jar jsrun.jar app/run.js -a -t=templates/jsdoc mycode.js\n\nThe above assumes your current working directory contains jsrun.jar,\nthe \"app\" and \"templates\" subdirectories from the standard JsDoc\nToolkit distribution and that the relative path to the code you wish\nto document is \"mycode.js\".\n\nThe output documentation files will be saved to a new directory named\n\"out\" (by default) in the current directory, or if you specify a\n-d=somewhere_else option, to the somewhere_else directory.\n\nFor help (usage notes) enter this on the command line:\n\n$ java -jar jsrun.jar app/run.js --help\n\nMore information about the various command line options used by JsDoc\nToolkit are available on the project wiki.\n\n======================================================================\n\nRUNNING VIA SHELL SCRIPT\n\nAvi Deitcher has contributed the file jsrun.sh with the following usage notes:\n\nA script to simplify running jsdoc from the command-line, especially when\nrunning from within a development or build environment such as ant.\n\nNormally, to run jsdoc, you need a command-line as the following:\njava -Djsdoc.dir=/some/long/dir/path/to/jsdoc -jar\n/some/long/dir/path/to/jsdoc/jsrun.jar /some/long/dir/path/to/jsdoc/app/run.js\n-t=template -r=4 /some/long/dir/path/to/my/src/code\n\nThis can get tedious to redo time and again, and difficult to use from within a build environment.\n\nTo simplify the process, jsrun.sh will automatically run this path, as well as passing through any arguments.\n\nUsage: jsrun.sh \u003crun.js arguments\u003e\n\nAll \u003crun.js arguments\u003e will be passed through.\nAdditionally, jsrun.sh will take the following actions:\n1) If the environment variable JSDOCDIR is set, it will add\n\"-Djsdoc.dir=$JSDOCDIR\" to the command-line\n2) If the environment variable JSDOCTEMPLATEDIR is set, it will add\n\"-Djsdoc.template.dir=$JSDOCTEMPLATEDIR\" to the command-line\n3) java with the appropriate path to jsrun.jar and run.js will be instantiated\n\nIf not variables are set, it is assumed that the path to jsrun.jar and app/ is in the current working directory.\n\nExample:\n# jsrun.sh ./src/\nAssuming JSDOCDIR=/some/path/to/my/jsdoc will cause the following command to\nexecute:\njava -Djsdoc.dir=/some/path/to/my/jsdoc -jar /some/path/to/my/jsdoc/jsrun.jar\n/some/path/to/my/jsdoc/app/run.js ./src/\n\n======================================================================\n\nTESTING:\n\nTo run the suite of unit tests included with JsDoc Toolkit enter this\non the command line:\n\n$ java -jar jsrun.jar app/run.js -T\n\nTo see a dump of the internal data structure that JsDoc Toolkit has\nbuilt from your source files use this command:\n\n$ java -jar jsrun.jar app/run.js mycode.js -Z\n\n======================================================================\n\nLICENSE:\n\nJSDoc.pm\n\nThis project is based on the JSDoc.pm tool, created by Michael\nMathews and Gabriel Reid. More information on JsDoc.pm can\nbe found on the JSDoc.pm homepage: http://jsdoc.sourceforge.net/\n\nComplete documentation on JsDoc Toolkit can be found on the project\nwiki at http://code.google.com/p/jsdoc-toolkit/w/list\n\nRhino\n\nRhino (JavaScript in Java) is open source and licensed by Mozilla\nunder the MPL 1.1 or later/GPL 2.0 or later licenses, the text of\nwhich is available at http://www.mozilla.org/MPL/\n\nYou can obtain the source code for Rhino from the Mozilla web site at\nhttp://www.mozilla.org/rhino/download.html\n\nJsDoc Toolkit is a larger work that uses the Rhino JavaScript engine\nbut is not derived from it in any way. The Rhino library is used \nwithout modification and without any claims whatsoever.\n\nThe Rhino Debugger\n\nYou can obtain more information about the Rhino Debugger from the \nMozilla web site at http://www.mozilla.org/rhino/debugger.html\n\nJsDoc Toolkit is a larger work that uses the Rhino Debugger but\nis not derived from it in any way. The Rhino Debugger is used\nwithout modification and without any claims whatsoever.\n\nJsDoc Toolkit\n\nAll code specific to JsDoc Toolkit are free, open source and licensed\nfor use under the X11/MIT License.\n\nJsDoc Toolkit is Copyright (c)2009 Michael Mathews \u003cmicmath@gmail.com\u003e\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms below.\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions: The above copyright notice and this\npermission notice must be included in all copies or substantial\nportions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsymphonycms%2Fsymphony-jsdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsymphonycms%2Fsymphony-jsdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsymphonycms%2Fsymphony-jsdoc/lists"}