phpdoc v0.3.0

phpdoc

This is a Node.js-compatible wrapper for phpdoc.

Installing

Add phpdoc as a dev (probably) dependency:

$ npm install --save-dev phpdoc;

Usage

Currently only the "run" command is supported.

var PHPDoc = require("phpdoc");
var phpdoc = new PHPDoc("<path/to/phpdoc>");
phpdoc.run([["-d", "<directories>", "-t", "<output location>"]]);

Note that you must have phpdoc available already in order to use this module. If you don't, you can do something like the following (using bin-wrapper):

var path = require("path");
var BinWrapper = require("bin-wrapper");
var phpdocBin = new BinWrapper()
    .src("http://phpdoc.org/phpDocumentor.phar")
    .dest(path.join("phpdoc"))
    .use("phpDocumentor.phar");
phpdocBin.run(["--version"], function()
{
    var phpdoc = new PHPDoc(phpdocBin.path());
    // do what you want with it...
});

License

Copyright © 2015 Bob W. Hogg. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.