Added support for private APIs

[justinnichols]

Added @apiPrivate to support the ability to specify
if an API is a private API. apidoc now also has a
--private false|true parameter on the command line
that defaults to false. If false, it does not include
any API block that contains @apiPrivate. If true, it
will include the API (assuming the API is also not marked
as @apiIgnore).

[mstratman]

Corresponding: apidoc/apidoc-core#46
(in case anyone else stumbles upon this and wants to use it before it's merged)

[rottmann]

Thank you, merged in the next version.

[justinnichols]

@rottmann I'm a little confused. Are you just copy/pasting the code changes? Or is the next version different enough that you decided not to merge this code specifically? (Since you closed the pull request, but didn't actually merge)

[miguelduarte42]

For anyone else wondering why they cannot actually use this feature, the configuration parameter is not privateas mentioned in the change log and here, but actually apiprivate when running from gulp or another tool

[justinnichols]

I don't know about the changelog, but my commit log indeed says @apiPrivate.

Now what I failed to do in time was to get the website documentation updated to include this parameter, but I've since put in a pull request for that and hopefully it'll be merged/rebuilt/deployed soon.

[miguelduarte42]

What I am referring to is the following information:

apidoc now also has a --private false|true parameter on the command line"

However, internally, it uses the apiprivate flag to actually include the private methods or not. In gulp, I had to use it like this to have any effect:

gulp.task('apidoc-private', function (done) {
  apidoc({
    src: "api/endpoint",
    dest: "api/private/doc",
    apiprivate: true
  }, done);
});

[justinnichols]

Ah, I see. Sorry for the confusion. I based it on the other command-line parameters, none of which prefaced with "api", but for the apidoc itself, all of them are prefaced with "api".

Hopefully when the website documentation is updated, it'll be more clear.