jsdoctypeparser
Advanced tools
Comparing version 1.0.0 to 1.0.1
{ | ||
"name": "jsdoctypeparser", | ||
"description": "Strict JsDoc type expression parser", | ||
"version": "1.0.0", | ||
"version": "1.0.1", | ||
"author": "Orga Chem <orga.chem.job@gmail.com>", | ||
"keywords": [ | ||
"jsdoc", | ||
"type expression", | ||
"parser" | ||
@@ -9,0 +10,0 @@ ], |
@@ -1,4 +0,4 @@ | ||
Jsdoc strict type parser | ||
======================== | ||
# Jsdoc strict type parser | ||
[![Build Status](https://travis-ci.org/OrgaChem/jsdoc-strict-type-parser.png?branch=master)](https://travis-ci.org/OrgaChem/jsdoc-strict-type-parser) | ||
[![NPM version](https://badge.fury.io/js/jsdoctypeparser.png)](http://badge.fury.io/js/jsdoctypeparser) | ||
@@ -10,3 +10,4 @@ This module is Jsdoc type expression parser. | ||
* Parse strict | ||
* Convert a type name to a link by ```toHtml()``` | ||
* Build DOM | ||
* Convert a type name to a link by using ```toHtml()``` | ||
@@ -22,4 +23,5 @@ This parser can parse: | ||
Parsing | ||
======= | ||
## Parsing | ||
``` | ||
@@ -60,5 +62,5 @@ var Parser = require('jsdoctypeparser').Parser; | ||
DOM Specification | ||
----------------- | ||
### Type name | ||
### DOM Specification | ||
#### Type name | ||
``` | ||
@@ -70,3 +72,3 @@ TypeName = { | ||
### Type Union | ||
#### Type Union | ||
``` | ||
@@ -84,3 +86,3 @@ TypeUnion = { | ||
### Generic type | ||
#### Generic type | ||
``` | ||
@@ -93,3 +95,3 @@ GenericType = { | ||
### Function type | ||
#### Function type | ||
``` | ||
@@ -104,3 +106,3 @@ FunctionType = { | ||
### Record type | ||
#### Record type | ||
``` | ||
@@ -117,4 +119,4 @@ RecordType = { | ||
Publishing | ||
========== | ||
## Publishing | ||
``` | ||
@@ -130,4 +132,3 @@ var Parser = require('jsdoctypeparser).Parser; | ||
File name config | ||
---------------- | ||
### Customize type name URI | ||
You can change a file URL by set ```TypeBulder.TypeName.getUrlByTypeName(typeName)```. | ||
@@ -144,5 +145,4 @@ | ||
License | ||
======= | ||
## License | ||
This script licensed under the MIT. | ||
See: [http://orgachem.mit-license.org](http://orgachem.mit-license.org) |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
108435