dgeni-packages - npm Package Compare versions

Comparing version 0.7.1 to 0.8.0

CHANGELOG.md

		@@ -1,8 +0,17 @@
		## v0.7.0 03/11/2014
		## v0.8.0 03/18/2014

		New Features

		* feat(examples/index.template): allow ng-app to be defined in the example 9b760c08
		* feat(jsdoc package): use `jsdoc` rather than `js` doc-extractor 72866263


		## v0.7.1 03/11/2014

		Minor Features
		feat(api-docs): add configuration for paths 8ddcf647
		feat(runnableExample template): provide the path to the example 353eef6e

		* feat(api-docs): add configuration for paths 8ddcf647
		* feat(runnableExample template): provide the path to the example 353eef6e


		## v0.7.0 03/11/2014
		@@ -9,0 +18,0 @@

examples/README.md

		@@ -21,2 +21,19 @@ # Examples Dgeni Package
		};
		```

		Then inside your docs you can markup inline-examples such as:

		```
		Some text before the example

		<example name="example-name">
		<file name="index.html">
		<div>The main HTML for the example</div>
		</file>
		<file name="app.js">
		// Some JavaScript code to be included in the example
		</file>
		</example>

		Some text after the example
		```

jsdoc/index.js

		module.exports = function(config) {

		config.append('source.extractors', require('./extractors/js'));
		config.append('source.extractors', require('./extractors/jsdoc'));

		@@ -5,0 +5,0 @@ config.append('processing.processors', [

package.json

		{
		"name": "dgeni-packages",
		"version": "0.7.1",
		"version": "0.8.0",
		"description": "A collection of dgeni packages for generating documentation from source code",
		@@ -5,0 +5,0 @@ "scripts": {

README.md

		@@ -55,14 +55,10 @@ # Dgeni Packages

		* `module` -
		Some docs that represent a module. The processor will compute the package name for the module (e.g.
		angular or angular-sanitize). It also collects up all documents that belong to the module and
		attaches them to the module doc in the `components` property.
		* `api-docs` -
		This processor runs a bunch of computations that are specifically related to docs for API components.
		In particular, it will compute the package name for the module (e.g.
		angular or angular-sanitize, it collects up all documents that belong to the module and
		attaches them to the module doc in the `components` property, it computes the URL path to the document
		in the docs app and the outputPath to the final output file, it relates documents about angular
		services to their corresponding angular service provider document.

		* `paths` -
		This processor computes the URL to the document and the path to the final output file for the
		document.

		* `service-provider-mapping` - relates documents about angular services to their corresponding
		angular service provider document.

		This package also provides a set of templates for generating an HTML file for each document: api,
		@@ -104,2 +100,2 @@ directive, error, filter function, input, module, object, overview, provider, service, type and a
		},
		```
		```

examples/templates/examples/index.template.html

Sorry, the diff of this file is not supported yet

New alerts