Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow including docs for internal/protected members but not private members #434

Closed
TAGC opened this issue Feb 28, 2019 · 2 comments · Fixed by #2270
Closed

Allow including docs for internal/protected members but not private members #434

TAGC opened this issue Feb 28, 2019 · 2 comments · Fixed by #2270
Assignees
@IgnatBeresnev
Labels
enhancement An issue for a feature or an overall improvement
Milestone
Backlog Stable

Comments

@TAGC
Copy link

TAGC commented Feb 28, 2019 •
edited
Loading

Currently Dokka only exposes the boolean configuration option includeNonPublic, which forces you to choose between including only public members; or private, internal, protected and public members with no in-between.

It would be nice to be able to be able to include documentation for internal/protected members without having a plethora of warnings about not documenting private members.
@TAGC TAGC changed the title Allow includings docs for internal members but not private members Allow includings docs for internal/protected members but not private members Feb 28, 2019
@TAGC TAGC changed the title Allow includings docs for internal/protected members but not private members Allow including docs for internal/protected members but not private members Feb 28, 2019
@kamildoleglo kamildoleglo added the enhancement An issue for a feature or an overall improvement label Sep 25, 2019
@Kordyjan Kordyjan added this to the Stable milestone Sep 1, 2020
@SUPERCILEX SUPERCILEX mentioned this issue Sep 12, 2020
Closed
@mkrussel77
Copy link

What I would really want is to show public and protected and not internal and private.
The default option now is to show public/internal and skip protected/private.

Internal should be grouped with private, and protected with public if you do want to have a single flag.

roy-hopkins added a commit to R3Conclave/dokka that referenced this issue Apr 21, 2021
@roy-hopkins
Include protected members when 'includeNonPublic' is false.
1698c5d 
See Dokka issue Kotlin#434 - when this issue is fixed, this change can be reverted.
@IgnatBeresnev IgnatBeresnev self-assigned this Dec 8, 2021
@IgnatBeresnev IgnatBeresnev linked a pull request Dec 13, 2021 that will close this issue
Introduce documentedVisibilities setting #2270
Merged
@IgnatBeresnev
Copy link
Member

IgnatBeresnev commented Dec 23, 2021 •
edited
Loading

Will be in one of the nearest releases (1.6.20?). You'll be able to document whatever visibilities you choose

    documentedVisibilities.set(
        setOf(
            Visibility.PUBLIC,
            Visibility.PRIVATE,
            Visibility.PROTECTED,
            Visibility.INTERNAL,
            Visibility.PACKAGE // for java
        )
    )

@vitorhugods vitorhugods mentioned this issue Jun 27, 2022
Merged
4 tasks
filipesoliveira added a commit to R3Conclave/dokka that referenced this issue Aug 24, 2022
@filipesoliveira
CON-847 Synchronised conclave with conclave-change
ff1d3db 
Keep in mind that conclave-change branch was updated with the changes from conclave branch and then the files from conclave-changes were copied to the conclave branch. This had to be done because conclave branch was created from 1.5.31 branch instead of conclave-branch.

Commits made by R3 that were present in the conclave-branch:
1) Add "suppress" to the per-package configuration options.
2) Add new "suppress" per-package option.
3) Include protected members when 'includeNonPublic' is false. See Dokka issue Kotlin#434 - when this issue is fixed, this change can be reverted.
4) Suppress obvious properties if suppressObviousFunctions is set.
5) Ensure filters are run over Enum values so obvious functions/properties/etc. can be suppressed.
6) Ensure property getter/setters inherit documentation from property. Add Exception/Throwable to list of obvious functions
7) Add translation of ByteArray, Unit and integer types to JVM types.
8) Downgrade kotlinx_html_version to 0.7.2 because the latest version is not yet in the repository.
9) Update class template to include missing marker that is required for IDE integration
10) Fixes for Conclave docs after full docs review.
11) Remove final from properties
12) Update jquery version in Javadoc plugin
13) Update another jquery file to the latest version

file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@IgnatBeresnev IgnatBeresnev

Labels
enhancement An issue for a feature or an overall improvement
Projects
None yet
Milestone
Backlog Stable
Development

Successfully merging a pull request may close this issue.

Introduce documentedVisibilities setting Kotlin/dokka
Always show protected members
5 participants
@TAGC @kamildoleglo @Kordyjan @mkrussel77 @IgnatBeresnev