angular / dgeni-packages

A collection of dgeni packages for generating documentation from source code.
MIT License
142 stars 101 forks source link

prevent TS exports marked as "@internal" or "@private" to be exported in readTypeScriptModules() #199

Closed dennybiasiolli closed 7 years ago

dennybiasiolli commented 7 years ago

If we have something like this

/**
 * @private
 */
export var y = 12;

/**
 * @internal
 */
export var z = 123;

var y and var z will be exported as results of readTypeScriptModules()

It will be useful because in ionic2 they are using this functionality in their custom typescript processor: repo link

petebacondarwin commented 7 years ago

I think you want to use @internal?

On 14 November 2016 at 19:39, Denny Biasiolli notifications@github.com wrote:

If we have something like this

/**

  • @private */ export var y = 12;

var y will be exported as results of readTypeScriptModules()

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/angular/dgeni-packages/issues/199, or mute the thread https://github.com/notifications/unsubscribe-auth/AAA9J_isP8YtVk1bejvjDIuakkbTkWHgks5q-LkLgaJpZM4KxuGg .

dennybiasiolli commented 7 years ago

@petebacondarwin same problem with @internal, now I include this in PR

petebacondarwin commented 7 years ago

See https://github.com/angular/dgeni-packages/pull/200#issuecomment-311942511