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.

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

docs: Add missing KDocs for exposed-core table API #1946

Merged
merged 3 commits into from
Dec 19, 2023

Conversation

bog-walk
Copy link
Member

Add KDocs to exposed-core files relating to Table and Column.

All public API elements now show a KDoc when hovered over by a mouse in IDE or when Quick Documentation shortcut is used (F1 | Ctrl+Q).

The only module with missing KDocs is now exposed-dao.

Add KDocs to `exposed-core` files relating to Table and Column.
@bog-walk bog-walk requested a review from e5l December 16, 2023 14:55
Copy link
Member

@e5l e5l left a comment

Choose a reason for hiding this comment

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

lgtm

@@ -1,13 +1,19 @@
package org.jetbrains.exposed.sql

/** Represents a temporary SQL identifier, [alias], for a [delegate] table. */
Copy link
Member

Choose a reason for hiding this comment

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

we could mention if it exists only on Exposed side or also on the Db side

Add minor edit to alias extension functions.
@bog-walk bog-walk merged commit cd1084b into main Dec 19, 2023
3 checks passed
@bog-walk bog-walk deleted the bog-walk/add-missing-kdocs-table branch December 19, 2023 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants