search

open-dis / opendis7-java

Project to provide a complete type-safe Java implementation of the DIS Protocol version 7 (IEEE 1278.1-2012) and SISO-REF-010 Enumerations specifications.
Other
6 stars 5 forks source link

missing javadoc in methods AllPduRoundTripTest #15

Closed brutzman closed 2 years ago

brutzman commented 2 years ago

Found during tutorial:

[loading /modules/java.base/java/lang/annotation/Documented.class] C:\x-nps-gitlab\opendis7-java\test\edu\nps\moves\dis7\test\AllPduRoundTripTest.java:52: warning: no comment public static void afterAllTests() C:\x-nps-gitlab\opendis7-java\test\edu\nps\moves\dis7\test\AllPduRoundTripTest.java:46: warning: no comment public static void beforeAllTests() C:\x-nps-gitlab\opendis7-java\test\edu\nps\moves\dis7\test\AllPduRoundTripTest.java:261: warning: no comment public static void main(String[] args) C:\x-nps-gitlab\opendis7-java\test\edu\nps\moves\dis7\test\AllPduRoundTripTest.java:57: warning: no comment public void setUp() { C:\x-nps-gitlab\opendis7-java\test\edu\nps\moves\dis7\test\AllPduRoundTripTest.java:66: warning: no comment public void tearDown() C:\x-nps-gitlab\opendis7-java\test\edu\nps\moves\dis7\test\AllPduRoundTripTest.java:71: warning: no comment public void testRoundTripAllPdus()

brutzman commented 2 years ago

Added missing Javadoc to methods in 10 test classes so that compilation build runs cleanly.

This is a good practice for documentation but also for code maintenance. Fixing all warnings, even simple ones, means that actual warnings (which are potential errors) all stand out prominently and get fixed.

brutzman commented 2 years ago

Resolution commit: https://github.com/open-dis/opendis7-java/commit/d076d1e905063975fea377507484c64170cc48ad