Skip to content
This repository has been archived by the owner on Aug 30, 2022. It is now read-only.

Move KDoc to be more discoverable #55

Merged
merged 2 commits into from
Apr 14, 2020
Merged

Move KDoc to be more discoverable #55

merged 2 commits into from
Apr 14, 2020

Conversation

twyatt
Copy link
Member

@twyatt twyatt commented Apr 12, 2020

KDoc was on the concrete implementations, which from the standpoint of a consumer of the library, you're probably going to be examining the extension functions you call or the interfaces that are returned.

See also: Should Javadoc comments be added to the implementation?

@twyatt twyatt added this to the 1.0.0 milestone Apr 12, 2020
@twyatt twyatt changed the title Move KDoc from CoroutinesGatt to Gatt Move KDoc from concrete implementations to interfaces Apr 12, 2020
@codecov
Copy link

codecov bot commented Apr 12, 2020

Codecov Report

Merging #55 into develop will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             develop      #55   +/-   ##
==========================================
  Coverage      74.89%   74.89%           
  Complexity        36       36           
==========================================
  Files             14       14           
  Lines            243      243           
  Branches          26       26           
==========================================
  Hits             182      182           
  Misses            53       53           
  Partials           8        8           
Impacted Files Coverage Δ Complexity Δ
core/src/main/java/android/BluetoothDevice.kt 0.00% <ø> (ø) 0.00 <0.00> (ø)
core/src/main/java/device/CoroutinesDevice.kt 85.71% <ø> (ø) 3.00 <0.00> (ø)
core/src/main/java/gatt/CoroutinesGatt.kt 47.36% <ø> (ø) 9.00 <0.00> (ø)
core/src/main/java/gatt/Gatt.kt 100.00% <ø> (ø) 0.00 <0.00> (ø)

@twyatt twyatt changed the title Move KDoc from concrete implementations to interfaces Move KDoc to be more discoverable Apr 13, 2020
@twyatt twyatt marked this pull request as ready for review April 13, 2020 18:43
@twyatt twyatt merged commit a9f8edc into develop Apr 14, 2020
@twyatt twyatt deleted the twyatt/kdoc branch April 14, 2020 21:25
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants