Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
The node.js documentation generation utility by angular.js and other projects.
To get started, install the dependencies and then try out the example.
You'll need node.js and a bunch of npm modules installed to run this tool. Get node.js from here: http://nodejs.org/. Then, in the root folder of the project run:
npm install
This will install the npm modules needed for documentation generation. If you want to run the example you'll need to install more dependencies - see below.
The tool is modular. There are three main phases of document generation:
Each of these phases will execute a set of plugins (extractors, processors and renderers) to generate the documentation.
In practice all these phases are executed by a pipeline of document processors. Each processor can provide a list of other processors that it must come before or after, and it can provide zero or more of the following handlers:
init(config, injectables) { ... }
- gives the processor and opportunity to initialize itself
based on the configuration object and also add items to the dependency injection container.process(docs, ...) { ... }
- invoked by the dependency injector. Each processor's process
handler is called an order that fits with the declared runBefore
and runAfter
dependencies.The before
and after
handlers can be synchronous or asynchronous. If they are synchronous then
they should return undefined or a new array of documents. If they are asynchronous then they must
return a promise, which will resolve to undefined or a new collection of documents.
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:
Document processors, templates and other configuration can be bundled into a package
. Packages
can load up and extend other packages. In this way you can build up your custom configuration on
top of an existing configuration.
There are some initial packages defined in the dgeni-packages repository.
v0.2.2 (6th March 2014)
Bug fixes
FAQs
Flexible JavaScript documentation generator used by both AngularJS and Angular
The npm package dgeni receives a total of 5,429 weekly downloads. As such, dgeni popularity was classified as popular.
We found that dgeni demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 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
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.