Add javadoc docstrings to coppercore

[jkleiber]

Summary
When publishing to maven in #39 we want to produce decent docs so we can use our own code (and so others can too if they want)

The objective of this ticket is to add docstrings to each class, method, and class member variable so the output of ./gradlew publishToMavenLocal produces no spam related to having no docstrings

Work Required

• Docstrings are added throughout the project

Verification

• ./gradlew publishToMavenLocal produces no spam related to having no docstrings
• Show the generated javadocs

[jkleiber]

@aidnem can you assign this to one of the new members?

[aidnem]

@jkleiber there are a ton of comments that need to be added, could we split this between Samson and Josh? We could give each one a few modules to do to even out the load.

[jkleiber]

@aidnem works for me

[aidnem]

Here's the breakdown of how many comments are needed in each package:

Module	Missing Comments
Geometry	23
Math	7
Monitors	3
Parameter Tools	19
Vision	44
WPILib Interface	24
Total	120

I figured I'd break it up as follows:

Joshua

• Vision (44)
• Parameter Tools (19)
  63 total

Samson

• Geometry (23)
• Math (7)
• Monitors (3)
• WPILib Interface (24)
  57 Total

[aidnem]

Created and assigned #65 and #66

[Samson560915]

@jkleiber Help Justin, have you seen this error before, help please. It might have something to do with coppercore but I don't know. Help, please.

Could not resolve all artifacts for configuration ':classpath'.
   > Could not resolve com.vanniktech:gradle-maven-publish-plugin:0.30.0.
     Required by:
         project : > com.vanniktech.maven.publish:com.vanniktech.maven.publish.gradle.plugin:0.30.0
      > No matching variant of com.vanniktech:gradle-maven-publish-plugin:0.30.0 was found. The consumer was configured to find a library for use during runtime, compatible with Java 8, packaged as a jar, and its dependencies declared externally, as well as attribute 'org.gradle.plugin.api-version' with value '8.7' but:
          - Variant 'apiElements' declares a library, packaged as a jar, and its dependencies declared externally:
              - Incompatible because this component declares a component for use during compile-time, compatible with Java 11 and the consumer needed a component for use during runtime, compatible with Java 8
              - Other compatible attribute:
                  - Doesn't say anything about org.gradle.plugin.api-version (required '8.7')
          - Variant 'runtimeElements' declares a library for use during runtime, packaged as a jar, and its dependencies declared externally:
              - Incompatible because this component declares a component, compatible with Java 11 and the consumer needed a component, compatible with Java 8
              - Other compatible attribute:
                  - Doesn't say anything about org.gradle.plugin.api-version (required '8.7')
          - Variant 'sourcesElements' declares a component for use during runtime, and its dependencies declared externally:
              - Incompatible because this component declares documentation and the consumer needed a library
              - Other compatible attributes:
                  - Doesn't say anything about its elements (required them packaged as a jar)
                  - Doesn't say anything about its target Java version (required compatibility with Java 8)
                  - Doesn't say anything about org.gradle.plugin.api-version (required '8.7')

[jkleiber]

@Samson560915 I haven't seen this error before - could you point me to the branch / commit you are working on? that way I have enough context to help

[Samson560915]

66-geometry-math-monitors-wpilib-interface-docstrings, I have no clue I think its on like coppercore

[jkleiber]

@Samson560915 it says that branch has no difference with main. You need to push your code so that I can see it

[Samson560915]

Nvm Minh figured it out

…

On Thu, Jan 9, 2025, 11:00 PM Justin Kleiber ***@***.***> wrote: @Samson560915 <https://github.com/Samson560915> it says that branch has no difference with main. You need to push your code so that I can see it — Reply to this email directly, view it on GitHub <#49 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BM3HNIP5HLSWSXQGNVHTFND2J5AUJAVCNFSM6AAAAABSMZ5QEKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKOBRGY4TIOJXHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>