krampstudio/grunt-jsdoc

Include symbols marked with @private with the "-p" cli argument

natterstefan opened this issue · 3 comments

Hi, as my title says I want to mark some functions in my @class as private but want them to be visible in the JsDocs template/site.

In the JSDocs docu I saw it should be achievable with -p, --private (read more here).

How can I enable this with your plugin?


Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Hi all jsdoc options are supported through the options. In your Gruntfile.js, you'll have something like :

grunt.initConfig({
  jsdoc : {
     dist : {
         src: ['**/*.js'],
         dest : 'doc',
         options: {
           private : true
         }
     }
  }
});

@natterstefan did the configuration above help you ?

Hi @krampstudio, thanks for your response. Too be honest I am not sure and can't recall. Sorry. So, it's fine for me if you close the issue. If it's still an issue, somebody else can reopen it again.