dgeni-packages
Advanced tools
A collection of dgeni packages for generating documentation from source code
This repository contains a collection of dgeni packages that can be used by the dgeni documentation generator to create documentation from source code.
Out of the box there are the following packages:
jsdoc - a standard set of processors that can extract jsdoc documents and render them as HTML.ngdoc - (depends upon the jsdoc package) an extra set of processors and templates that
are specific to angularjs projects.jsdoc PackageThis package contains the following processors:
doc-extractor - used to load up documents from files. This processor can be configured to use a
set of extractors. The jsdoc package has a single js extractor, which can extract documents
from jsdoc style comments in files.tag-parser - parses the jsdoc tags in the extracted documents.tag-extractor - extracts the tags information and converts it to specific properties on
the documents, based on a set of tag-definitions. The jsdoc package contains definitions for the
following tags: name, memberof, param, property, returns, module, description, usage,
animations, constructor, class, classdesc, global, namespace, method, type and kind.nunjucks-renderer - uses the Nunjucks template library to render the documents into files, such
as HTML or JS, based on templates.This package does not provide any templates.
ngdoc PackageThere is one new document extractor in this package, ngdoc, which can pull a single document from
an ngdoc content file.
On top of the processors provided by the jsdoc package, this packages adds the following processors:
filter-ngdocs -
For AngularJS we are only interested in documents that contain the @ngdoc tag. This processor
removes docs that do not contain this tag.
memberof -
All docs that have a @memberof tag are attached to their parent document and removed from the top
level list of docs.
links -
Parse all {@link ... } inline tags in the docs and replace with real anchors. This processor is
able to compute URLs for code references.
examples -
Parse the <example> tags from the content, generating new docs that will be converted to extra
files that can be loaded by the application and used, for example, in live in-place demos of the
examples and e2e testing.
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.
This package also provides a set of templates for generating an HTML file for each document: api, directive, error, filter function, input, module, object, overview, provider, service, type and a number to support rendering of the runnable examples.
We render each of these documents as an HTML page. We use the "nunjucks" JavaScript template tool-kit to generate HTML based on the data in each document. We have nunjucks tags and filters that can render links and text as markdown and will highlight code.
The template used to render the doc is computed by a templateFinder, which uses the first match
from a set of patterns in a set of folders, provided in the configuration. This allows a lot of control to provide
generic templates for most situations and specific templates for exceptional cases.
Here is an example of the angularjs patterns:
rendering: {
...
templatePatterns: [
'${ doc.template }',
'${ doc.id }.${ doc.docType }.template.html',
'${ doc.id }.template.html',
'${ doc.docType }.template.html'
],
...
templateFolders: [
'templates'
]
},
v0.9.0 05/01/2014
This is a major refactoring release which is compatible with Dgeni v0.3.x. There are many breaking changes.
The packages have been refactored into smaller more focussed sets of processors.
Error: No provider for "templateEngine"! (Resolving: templateEngine)With Dgeni 0.3.0 processors can declaratively export services to be injected into processors'
process() method. This release take full advantage of this, refactoring the structure of the
dependencies of various processors to simplify and enable more flexibility.
Previously processing of tags was somewhat distributed between the tagParser and the tagExtractor,
with various features rather hard-coded, such as canHaveType and canHaveName. This has all been
moved into tag definition transforms, which provide a much more flexible and powerful way to
define how to transform the simple text "parsed" from the tag into a rich object that can be
attached to the document.
Features
@type tag 904aa00b@method tag 6fc99313Refactorings
init and provide exports 0de2680ainit and provide exports 61ba9cb1init and provide exports 34d05b1finit and provide exports 3188ff14init and provide exports 5cbcbab6init and provide exports 0c006bb4init and provide exports f4b42dd6init and provide exports fce833c9Bug Fixes
env changed to templateEngine e4a756e0@see tags d73a842fFAQs
A collection of dgeni packages for generating documentation from source code
The npm package dgeni-packages receives a total of 3,445 weekly downloads. As such, dgeni-packages popularity was classified as popular.
We found that dgeni-packages demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.