Skip to content

Fixed broken KDoc links, added @ExcludeFromSources - #2201

Merged
Jolanrensen merged 9 commits into
masterfrom
fix-kdoc-broken-links-2183
Nov 6, 2026
Merged

Jolanrensen merged 9 commits into
masterfrom
fix-kdoc-broken-links-2183

Conversation

@Jolanrensen

@Jolanrensen Jolanrensen commented Oct 30, 2026 •

Copy link
Copy Markdown
Collaborator

Part of #2183. :dokkaGenerateModuleHtml: unresolved-link warnings dropped from ~1300 to ~400.

Fixes #605

  • A LOT of @ExcludeFromSources were added, some removed.
  • Parameters renamed, like: @param [col\] -> correct param names in valueCol/frameCol/colGroup
  • External references made fully qualified, like: [Iterable.contains] -> [kotlin.collections.contains];
  • Others, like: SingleColumn.except -> ColumnsSelectionDsl.except; @see [cols\] in all.kt.
  • more like those

Jolanrensen and others added 2 commits October 30, 2026 15:26
Co-authored-by: Junie <junie@jetbrains.com>
@Jolanrensen Jolanrensen changed the title Fix broken KDoc links in core (#2183) Fix broken KDoc links, adding @ExcludeFromSources Oct 30, 2026
Jolanrensen and others added 2 commits November 2, 2026 13:01
…opNaNs, ExpressionsGivenColumn, AddDataRowNote) (#2183)

Co-authored-by: Junie <junie@jetbrains.com>
@Jolanrensen
Jolanrensen force-pushed the fix-kdoc-broken-links-2183 branch 2 times, most recently from a51e91a to ecfc509 Compare November 2, 2026 15:56
@Jolanrensen Jolanrensen added the KDocs Improvements or additions to KDocs label Nov 2, 2026
@Jolanrensen
Jolanrensen force-pushed the fix-kdoc-broken-links-2183 branch 2 times, most recently from 36d5bde to bd3e23b Compare November 2, 2026 16:22
Co-authored-by: Junie <junie@jetbrains.com>
@Jolanrensen
Jolanrensen force-pushed the fix-kdoc-broken-links-2183 branch from bd3e23b to d8c75a4 Compare November 3, 2026 13:37

@jetbrains-air jetbrains-air Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jetbrains-air jetbrains-air Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, just one blocking item to address before merge!

Produced by Air Automations. Name: AI Review / Run: https://air.jetbrains.cloud/org/05cf1a7f-6ab5-713b-abd3-29d0c8a05e2d/automations/8daf2412-0b6c-4433-90c0-b40ab5aebcdb?run=9301bbfc-cbd7-4dca-9964-70d7d98bfd81

@Allex-Nik Allex-Nik left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool!
I left several notes where I suspect that something could be excluded as well :)

@Jolanrensen Jolanrensen changed the title Fix broken KDoc links, adding @ExcludeFromSources Fixed broken KDoc links, added @ExcludeFromSources Nov 6, 2026
@Jolanrensen

Copy link
Copy Markdown
Collaborator Author

Actually, one more thing: All nested elements inside every public interface Grammar { can be excluded too :o

@jetbrains-air jetbrains-air Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing the feedback, approving! 🎉

Produced by Air Automations. Name: AI Review / Run: https://air.jetbrains.cloud/org/05cf1a7f-6ab5-713b-abd3-29d0c8a05e2d/automations/8daf2412-0b6c-4433-90c0-b40ab5aebcdb?run=0ef824a7-33da-48f2-a5ea-d2a340d50844

@AndreiKingsley AndreiKingsley left a comment •

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!
One wrong thing in the generated code for ParsingOptions.kt:
I believe the note about null is not correct (or just redunant) for a reified type:
Image

@Jolanrensen

Copy link
Copy Markdown
Collaborator Author

@Allex-Nik @AndreiKingsley okay I added a bunch more @ExcludeFromSources inside all grammars

@Jolanrensen
Jolanrensen force-pushed the fix-kdoc-broken-links-2183 branch from bb1fe64 to eafadf6 Compare November 6, 2026 14:17

@jetbrains-air jetbrains-air Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AndreiKingsley

Copy link
Copy Markdown
Collaborator

@Jolanrensen be careful do not exclude the whole library!

@Jolanrensen
Jolanrensen force-pushed the fix-kdoc-broken-links-2183 branch from eafadf6 to f5ac67c Compare November 6, 2026 14:26

@jetbrains-air jetbrains-air Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, just one small blocking ktlint fix needed before merge!

Produced by Air Automations. Name: AI Review / Run: https://air.jetbrains.cloud/org/05cf1a7f-6ab5-713b-abd3-29d0c8a05e2d/automations/8daf2412-0b6c-4433-90c0-b40ab5aebcdb?run=dd9fab63-b41e-44d0-be74-ebc0646fd752

@jetbrains-air jetbrains-air Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Just one blocking item to fix before merge.

Produced by Air Automations. Name: AI Review / Run: https://air.jetbrains.cloud/org/05cf1a7f-6ab5-713b-abd3-29d0c8a05e2d/automations/8daf2412-0b6c-4433-90c0-b40ab5aebcdb?run=479a6e96-8ea1-4519-a178-be1072bc2729

@jetbrains-air jetbrains-air Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, just one blocking item to fix before merge!

Produced by Air Automations. Name: AI Review / Run: https://air.jetbrains.cloud/org/05cf1a7f-6ab5-713b-abd3-29d0c8a05e2d/automations/8daf2412-0b6c-4433-90c0-b40ab5aebcdb?run=39a8aed1-d94f-4c6b-8f16-b8565176c732

@Jolanrensen
Jolanrensen force-pushed the fix-kdoc-broken-links-2183 branch from f5ac67c to fddd856 Compare November 6, 2026 15:29

@jetbrains-air jetbrains-air Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix — all good now, approving! 🎉

Produced by Air Automations. Name: AI Review / Run: https://air.jetbrains.cloud/org/05cf1a7f-6ab5-713b-abd3-29d0c8a05e2d/automations/8daf2412-0b6c-4433-90c0-b40ab5aebcdb?run=6377e034-0165-4957-b3f8-7b68c869d031

@Jolanrensen
Jolanrensen merged commit 03154bd into master Nov 6, 2026
5 checks passed
@Jolanrensen
Jolanrensen deleted the fix-kdoc-broken-links-2183 branch November 6, 2026 16:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

KDocs Improvements or additions to KDocs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Annotate non-user facing documentation interfaces with @ExcludeFromSources

3 participants