docs: Add missing KDocs in all modules except core and dao #1876
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
e5l
requested changes
Oct 11, 2023
exposed-crypt/src/main/kotlin/org/jetbrains/exposed/crypt/EncryptedBinaryColumnType.kt
Show resolved
Hide resolved
exposed-crypt/src/main/kotlin/org/jetbrains/exposed/crypt/Encryptor.kt
Outdated
Show resolved
Hide resolved
| @@ -81,6 +81,9 @@ internal fun dateTimeWithFractionFormat(fraction: Int): DateTimeFormatter { | |||
| @Suppress("MagicNumber") | |||
| internal val LocalDate.millis get() = atStartOfDay(ZoneId.systemDefault()).toEpochSecond() * 1000 | |||
|
|
|||
| /** | |||
| * Column for storing dates. | |||
There was a problem hiding this comment.
It would be great to refer to the underlying type. There are lots of date types, and it's easy to confuse. Somewhere it also would be great to mention about precision
There was a problem hiding this comment.
@e5l To clarify about precision:
Do you mean the milli-/nano- second precision used to store a date/time value internally?
Or the precision of the specific formatters used by Exposed to log the values?
spring-transaction/src/main/kotlin/org/jetbrains/exposed/spring/SpringTransactionManager.kt
Show resolved
Hide resolved
exposed-spring-boot-starter/src/main/kotlin/org/jetbrains/exposed/spring/DatabaseInitializer.kt
Outdated
Show resolved
Hide resolved
Add KDocs to exposed-money
Add KDocs to exposed-crypt
Add KDocs to exposed-jodatime
Add KDocs to exposed-java-time
Add KDocs to exposed-kotlin-datetime
Add KDocs to exposed-spring-boot-starter & spring-transaction
Add KDocs to exposed-jdbc
Add applicable samples where possible. Adjust KDocs on class properties that don't return. Refactor description of spring boot DatabaseInitializer.
bog-walk
force-pushed
the
bog-walk/add-missing-kdocs
branch
from
a98930c
to
bf60df5
Compare
bog-walk
commented
Oct 12, 2023
| fun `test encryptedColumnType with a string`() { | ||
| fun testEncryptedColumnTypeWithAString() { |
There was a problem hiding this comment.
To use the contents of this test as a sample, the name format has to be changed, since KDocs can't reference a function with spaces: KTIJ-21878.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
All public API elements now show a KDoc when hovered over by a mouse in IDE or when a Quick Documentation shortcut is used (
F1|Ctrl+Q).EXCEPT: (this PR is already quite large, so these each will need their own)
exposed-coreexposed-daoEach commit covers a single module, so changes can be split if preferred.