Socket
Socket
Sign inDemoInstall

typedoc

Package Overview
Dependencies
19
Maintainers
1
Versions
299
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 0.0.2 to 0.0.3

bin/typedoc

6

bin/themes/default/theme.js

@@ -119,4 +119,4 @@ var __extends = this.__extends || function (d, b) {

this.project.url = 'modules/_globals.html';
urls.push(new TypeDoc.Models.UrlMapping('modules/_globals.html', this.project, 'reflection.hbs'));
this.project.url = 'globals.html';
urls.push(new TypeDoc.Models.UrlMapping('globals.html', this.project, 'reflection.hbs'));
urls.push(new TypeDoc.Models.UrlMapping('index.html', this.project, 'index.hbs'));

@@ -144,3 +144,3 @@

var root = new TypeDoc.Models.NavigationItem('Index', 'index.html');
new TypeDoc.Models.NavigationItem('<em>Globals</em>', 'modules/_globals.html', root);
new TypeDoc.Models.NavigationItem('<em>Globals</em>', 'globals.html', root);

@@ -147,0 +147,0 @@ var modules = this.project.getReflectionsByKind(TypeDoc.Models.Kind.SomeContainer);

{
"name": "typedoc",
"description": "Create api documentations for typescript projects.",
"version": "0.0.2",
"version": "0.0.3",
"bin": {
"tsd" : "bin/tsd"
"typedoc" : "bin/typedoc"
},

@@ -8,0 +8,0 @@ "author": {

@@ -16,7 +16,7 @@ # TypeDoc

Like the TypeScript compiler, TypeDoc comes with a binary that can be called from anywhere
if you install TypeDoc as a global module. The name of the executable is ``tsd``.
if you install TypeDoc as a global module. The name of the executable is ``typedoc``.
```shell
$ npm install typedoc --global
$ tsd
$ typedoc
```

@@ -36,2 +36,4 @@

### Shell
TypeDoc accepts most of the command line arguments that the TypeScript compiler accepts. One major

@@ -42,3 +44,37 @@ difference is the fact that one may pass an entire directory instead of individual files to the documentation

```shell
$ tsd --out path\to\documentation\ path\to\typescript\project\
```
$ typedoc --out path/to/documentation/ path/to/typescript/project/
```
### Arguments
#### ```--out <path/to/documentation/>```
Specifies the location the documentation should be written to.
#### ```--title <Documentation title>```
Set the name of the project that will be used in the header of the template.
#### ```--module <commonjs or amd>```
Specify module code generation: "commonjs" or "amd"
#### ```--target <ES3 or ES5>```
Specify ECMAScript target version: "ES3" (default), or "ES5"
### Gulp
There is a plugin available to run TypeDoc with Gulp created by Rogier Schouten. You can find it on NPM:
https://www.npmjs.org/package/gulp-typedoc/
## Document your code
TypeDoc runs the TypeScript compiler and extracts type information from the generated compiler symbols.
Therefore you don't have to include additional metadata within your comments, TypeScript specific elements
like classes, enumerations or property types and access modifiers will be automatically detected.
The documentation generator currently understands these javadoc tags:
* ```@param <param name>```
* ```@retrun(s)```
All other tags will be rendered as definition lists, so they are not lost.

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is too big to display

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc