Skip to content

Allow separate exclusion option for TS private modifier and JS #private identifier #3017

@stwlam

Description

@stwlam

Search Terms

private in:title

Problem

A class field declared as private via typescript access modifier is still overridable by subclasses (including external downstream ones), so one may want to document it to announce its existence and warn that it should not be overridden. A javascript #private class field doesn't share this problem, so excluding it from documentation entirely can still make sense.

Suggested Solution

An excludePrivateClassFields or similarly-named option that defaults to the value of excludePrivate, or excludePrivate additionally accepting something like a #privateOnly value

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueEasier issue for first time contributorshelp wantedContributions are especially encouraged

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions