codeactual / apidox Goto Github PK

I'd like an option to include the full source description -
i.e. in prependSourceDesc, to use this.fileComment.description instead of this.fileComment.description.summary

What's your opinion on these tags? At the moment I'm just writing English prose instead ('inherits from Blah', 'constructs Foo').

Hi-
I wrote a really small grunt task for apidox (pasted below). Do you want to put it into apidox or should I create a separate module?

var apidox = require('apidox');

module.exports = function (grunt)
{
    grunt.registerTask('apidox', 'Generate node.js API markdown with dox',
    function ()
    {
        grunt.config.requires('apidox.input', 'apidox.output');

        var input = grunt.config('apidox.input'),
            output = grunt.config('apidox.output'),
            dox = apidox.create();

        dox.set('input', input);
        dox.set('output', output);

        dox.parse()
        grunt.file.write(output, dox.convert());
    });
};

It would be great to be able to use @throws when you know a function can throw an exception.

I did a npm install apidox. All installed fine. However, dox version 0.4.6 is getting installed as a dependency.
Now, apidox's package.json says:

"dox": "^0.4.4"

which is fine but npmjs.com says the latest version of dox is 0.9.0.

Now, I had thought that the caret would allow anything below 1.0.0. However, then I read this on https://docs.npmjs.com/misc/semver:

Caret Ranges ^1.2.3 ^0.2.5 ^0.0.4
Allows changes that do not modify the left-most non-zero digit in the [major, minor, patch] tuple. In other words, this allows patch and minor updates for versions 1.0.0 and above, patch updates for versions 0.X >=0.1.0, and no updates for versions 0.0.X.

which means we'll not get the latest dox.

The reason I want apidox to use the latest dox is I just got emails from github saying there's a vulnerability in a dependency (marked 0.3.6). This used to be used by dox but it now uses markdown-it.

Sometimes it would be nice to specify

dox.set('source', false) // don't include "Source: ..."

dox.set('source', 'foo.js') // override the list of files displayed as the Source

Seems like there's a lot of opportunities to centralize repeated code.

npm ERR! Error while executing:
npm ERR! /usr/bin/git ls-remote -h -t git://github.com/codeactual/node-component-grunt.git
npm ERR! 
npm ERR! fatal: remote error: 
npm ERR!   Repository not found.

Did you delete node-component-grunt?

Docs say

• var dox = require('apidox').create();
  

• var markdown = dox
  

•   .set('input', '/path/to/source.js')
  

•   .set('output', '/path/to/output.md')
  

•   .parse()
  

•   .convert();
  

But I found I had to do

• var dox = require('apidox').create();
  

• dox
  

•   .set('input', '/path/to/source.js')
  

•   .set('output', '/path/to/output.md')
  

•   .parse();
  

• var markdown = dox.convert();