dgeni - npm Package Compare versions

Comparing version 0.0.3 to 0.1.0

NOTES.md

		@@ -54,19 +54,19 @@ # Implementation Notes

		### Relative Names
		Links can reference code relatively if they are in the same module and so on. With this scheme
		it is easy to achieve this. Assume that we are looking at the `ngClass` directive, which is in the
		`ng` module, the id of this component is `module:ng.directive:ngClass`. In order to reference the
		`ngShow` directive from here we can use any of:
		### Links to Code
		Since we have all the documents in a single collection during processing, we can do clever matching
		of links against code names. This means that you only have to provide enough of a components id to
		identify it unambiguously relative to other components in the collection.
		For example, in the AngularJS code we can refer to many components simply by their "name":

		```
		ngShow
		directive:ngShow
		module:ng.directive:ngShow
		$route
		ngSanitize
		```

		To reference a filter from the same page we would need to specify the filter type as a minimum:
		But were there is ambiguity we need to add progressively more information:

		```
		filter:currency
		module:ng.filter:currency
		ngMock:$log
		ngMockE2E:$httpBackend
		```
		@@ -73,0 +73,0 @@

package.json

		{
		"name": "dgeni",
		"version": "0.0.3",
		"version": "0.1.0",
		"description": "Flexible JavaScript documentation generator used by AngularJS",
		@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

		@@ -49,2 +49,24 @@ # Dgeni - Documentation Generator

		#### Pseudo Marker Processors

		There are a number of processors that don't do anything but act as markers for stages of the
		processing. You can use these markers in `runBefore` and `runAfter` properties to ensure that your
		processor is run at the right time. Here is the list of these marker processors in order:

		* loading-files
		* files-loaded
		* parsing-tags
		* tags-parsed
		* extracting-tags
		* tags-extracted
		* processing-docs
		* docs-processed
		* adding-extra-docs
		* extra-docs-added
		* rendering-docs
		* docs-rendered
		* writing-files
		* files-written


		## Packages
		@@ -51,0 +73,0 @@

lib/utils/partial-names.js

spec/utils/partial-names.spec.js

New alerts