From 4ddccf6286567b134745e067f37513871c2f9335 Mon Sep 17 00:00:00 2001 From: brutzman <brutzman@nps.edu> Date: Sun, 17 Oct 2021 12:18:40 -0700 Subject: [PATCH] javadoc summaries --- .../moves/dis7/test/AllPduRoundTripTest.java | 26 +++++++++---------- .../dis7/test/BitFieldRoundTripTest.java | 4 +++ .../nps/moves/dis7/test/CommentPdusTest.java | 4 +++ .../dis7/test/CreateAllObjectTypesTest.java | 2 ++ .../dis7/test/CreateAllPduTypesTest.java | 10 ++++--- .../dis7/test/DataQueryPduRoundTripTest.java | 4 +++ .../moves/dis7/test/DetonationPduTest.java | 2 +- .../moves/dis7/test/EntityStatePduTest.java | 5 +++- test/edu/nps/moves/dis7/test/FirePduTest.java | 5 +++- .../FixedAndVariableDatumRoundTripTest.java | 3 +++ .../nps/moves/dis7/test/MarshalEnumsTest.java | 6 ++--- .../test/NullFieldsEntityMarshallTest.java | 4 +-- .../dis7/test/ObjectTypeMarshallTest.java | 3 +++ .../nps/moves/dis7/test/PduFactoryTest.java | 3 ++- .../moves/dis7/test/X3dInterpolatorsTest.java | 4 +-- 15 files changed, 58 insertions(+), 27 deletions(-) diff --git a/test/edu/nps/moves/dis7/test/AllPduRoundTripTest.java b/test/edu/nps/moves/dis7/test/AllPduRoundTripTest.java index 1b62403537..e39ad8a28b 100644 --- a/test/edu/nps/moves/dis7/test/AllPduRoundTripTest.java +++ b/test/edu/nps/moves/dis7/test/AllPduRoundTripTest.java @@ -3,19 +3,6 @@ * This work is provided under a BSD open-source license, see project license.html and license.txt */ package edu.nps.moves.dis7.test; - -/** - * This is a test class (which can also be run through its main() method) which tests round-tripping of pdus, i.e., - * creating a pdu instance in java, serializing it and sending over the network as a stream of bytes, at the same time - * reading them back from the net. It also uses the pdu logger in the Player class to save the received pdus to disk. - * - * Two tests for pdu equivalency are performed: - * 1. Sent vs. received - * 2. Sent vs. persisted - * - * @author Mike Bailey, jmbailey@edu.nps.edu - * @version $Id$ - */ import edu.nps.moves.dis7.enumerations.Country; import edu.nps.moves.dis7.pdus.Pdu; import edu.nps.moves.dis7.utilities.DisThreadedNetworkInterface; @@ -30,6 +17,19 @@ import java.util.concurrent.Semaphore; import org.junit.jupiter.api.*; import static org.junit.jupiter.api.Assertions.*; +/** + * This is a test class (which can also be run through its main() method) which tests round-tripping of pdus, i.e., + * creating a pdu instance in java, serializing it and sending over the network as a stream of bytes, at the same time + * reading them back from the net. It also uses the pdu logger in the Player class to save the received pdus to disk. + * + * Two tests for pdu equivalency are performed: + * 1. Sent vs. received + * 2. Sent vs. persisted + * + * @author Mike Bailey, jmbailey@edu.nps.edu + * @version $Id$ + */ + @DisplayName("All Pdu Round Trip Test") public class AllPduRoundTripTest { diff --git a/test/edu/nps/moves/dis7/test/BitFieldRoundTripTest.java b/test/edu/nps/moves/dis7/test/BitFieldRoundTripTest.java index d7dd79acb5..3d8b0dfa80 100644 --- a/test/edu/nps/moves/dis7/test/BitFieldRoundTripTest.java +++ b/test/edu/nps/moves/dis7/test/BitFieldRoundTripTest.java @@ -17,6 +17,10 @@ import edu.nps.moves.dis7.utilities.PduFactory; import org.junit.jupiter.api.*; import static org.junit.jupiter.api.Assertions.assertTrue; +/** + * Unit tests for satisfactory handling of various necessary bit fields, supporting each data type. + * @author Don McGregor + */ @DisplayName("Bit Field Round TripTest") public class BitFieldRoundTripTest { diff --git a/test/edu/nps/moves/dis7/test/CommentPdusTest.java b/test/edu/nps/moves/dis7/test/CommentPdusTest.java index d464684e9c..d1ec2dc2ab 100644 --- a/test/edu/nps/moves/dis7/test/CommentPdusTest.java +++ b/test/edu/nps/moves/dis7/test/CommentPdusTest.java @@ -11,6 +11,10 @@ import edu.nps.moves.dis7.utilities.PduFactory; import org.junit.jupiter.api.*; import static org.junit.jupiter.api.Assertions.*; +/** + * Unit testing for CommentPdus, which can serve as a free-form holder for any kind of narrative information or simulation data. + * @author brutzman + */ @DisplayName("Comment Pdus Test") public class CommentPdusTest { diff --git a/test/edu/nps/moves/dis7/test/CreateAllObjectTypesTest.java b/test/edu/nps/moves/dis7/test/CreateAllObjectTypesTest.java index 4e508e526e..e474417050 100644 --- a/test/edu/nps/moves/dis7/test/CreateAllObjectTypesTest.java +++ b/test/edu/nps/moves/dis7/test/CreateAllObjectTypesTest.java @@ -9,6 +9,8 @@ import org.junit.jupiter.api.*; import static org.junit.jupiter.api.Assertions.assertNull; /** + * Manually constructed tests for many object types. + * TODO consider automated production. * CreateAllObjectTypes created on May 20, 2019 MOVES Institute Naval Postgraduate School, Monterey, CA, USA www.nps.edu * * @author Mike Bailey, jmbailey@edu.nps.edu diff --git a/test/edu/nps/moves/dis7/test/CreateAllPduTypesTest.java b/test/edu/nps/moves/dis7/test/CreateAllPduTypesTest.java index 4141da8e8b..8b47525ec9 100644 --- a/test/edu/nps/moves/dis7/test/CreateAllPduTypesTest.java +++ b/test/edu/nps/moves/dis7/test/CreateAllPduTypesTest.java @@ -81,13 +81,17 @@ import java.io.ByteArrayOutputStream; import java.io.DataOutputStream; import java.util.HashSet; import java.util.Set; -import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.AfterAll; -import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.AfterEach; +import static org.junit.jupiter.api.Assertions.*; import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; -import static org.junit.jupiter.api.Assertions.*; +/** + * Unit tests for satisfactory creation of all PDU objects. + * @author brutzman + */ public class CreateAllPduTypesTest { public CreateAllPduTypesTest() diff --git a/test/edu/nps/moves/dis7/test/DataQueryPduRoundTripTest.java b/test/edu/nps/moves/dis7/test/DataQueryPduRoundTripTest.java index 44970d6e99..2cb1a8bbaa 100644 --- a/test/edu/nps/moves/dis7/test/DataQueryPduRoundTripTest.java +++ b/test/edu/nps/moves/dis7/test/DataQueryPduRoundTripTest.java @@ -14,6 +14,10 @@ import edu.nps.moves.dis7.utilities.PduFactory; import org.junit.jupiter.api.*; import static org.junit.jupiter.api.Assertions.assertTrue; +/** Unit tests for DataQuery PDU fields and values. + * + * @author brutzman + */ @DisplayName("Data Query Pdu Round Test") public class DataQueryPduRoundTripTest { diff --git a/test/edu/nps/moves/dis7/test/DetonationPduTest.java b/test/edu/nps/moves/dis7/test/DetonationPduTest.java index 4f779c3381..51c9a5b0db 100644 --- a/test/edu/nps/moves/dis7/test/DetonationPduTest.java +++ b/test/edu/nps/moves/dis7/test/DetonationPduTest.java @@ -41,7 +41,7 @@ import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Test; /** - * + * Unit tests for Detonation PDU fields and values. * @author <a href="mailto:tdnorbra@nps.edu?subject=edu.nps.moves.dis7.DetonationPduTest">Terry Norbraten, NPS MOVES</a> */ @DisplayName("Detonation Pdu Test") diff --git a/test/edu/nps/moves/dis7/test/EntityStatePduTest.java b/test/edu/nps/moves/dis7/test/EntityStatePduTest.java index dfa61f78c4..859eee84f5 100644 --- a/test/edu/nps/moves/dis7/test/EntityStatePduTest.java +++ b/test/edu/nps/moves/dis7/test/EntityStatePduTest.java @@ -6,7 +6,6 @@ package edu.nps.moves.dis7.test; import edu.nps.moves.dis7.enumerations.Country; import edu.nps.moves.dis7.enumerations.EntityKind; -import edu.nps.moves.dis7.utilities.PduFactory; import edu.nps.moves.dis7.enumerations.PlatformDomain; import edu.nps.moves.dis7.pdus.Domain; import edu.nps.moves.dis7.pdus.EntityID; @@ -14,9 +13,13 @@ import edu.nps.moves.dis7.pdus.EntityMarking; import edu.nps.moves.dis7.pdus.EntityStatePdu; import edu.nps.moves.dis7.pdus.EntityType; import edu.nps.moves.dis7.pdus.Pdu; +import edu.nps.moves.dis7.utilities.PduFactory; import org.junit.jupiter.api.*; import static org.junit.jupiter.api.Assertions.*; +/** + * Unit tests for satisfactory handling of Entity State PDU (ESPDU) fields and values. + */ @DisplayName("Entity State Pdu Test") public class EntityStatePduTest extends PduTest { diff --git a/test/edu/nps/moves/dis7/test/FirePduTest.java b/test/edu/nps/moves/dis7/test/FirePduTest.java index 7899ca06ea..408ef61ead 100644 --- a/test/edu/nps/moves/dis7/test/FirePduTest.java +++ b/test/edu/nps/moves/dis7/test/FirePduTest.java @@ -4,12 +4,15 @@ */ package edu.nps.moves.dis7.test; -import edu.nps.moves.dis7.utilities.PduFactory; import edu.nps.moves.dis7.pdus.FirePdu; import edu.nps.moves.dis7.pdus.Pdu; +import edu.nps.moves.dis7.utilities.PduFactory; import org.junit.jupiter.api.*; import static org.junit.jupiter.api.Assertions.*; +/** + * Unit tests for satisfactory handling of Fire PDU fields and values. + */ @DisplayName("Fire Pdu Test") public class FirePduTest extends PduTest { diff --git a/test/edu/nps/moves/dis7/test/FixedAndVariableDatumRoundTripTest.java b/test/edu/nps/moves/dis7/test/FixedAndVariableDatumRoundTripTest.java index e3cfd3afc0..2863055b1b 100644 --- a/test/edu/nps/moves/dis7/test/FixedAndVariableDatumRoundTripTest.java +++ b/test/edu/nps/moves/dis7/test/FixedAndVariableDatumRoundTripTest.java @@ -14,6 +14,9 @@ import edu.nps.moves.dis7.utilities.PduFactory; import org.junit.jupiter.api.*; import static org.junit.jupiter.api.Assertions.assertTrue; +/** + * Unit tests for satisfactory handling of FixedDatum and VariableRecordType fields and values. + */ @DisplayName("Fixed and Variable Datum Round Trip Test") public class FixedAndVariableDatumRoundTripTest { diff --git a/test/edu/nps/moves/dis7/test/MarshalEnumsTest.java b/test/edu/nps/moves/dis7/test/MarshalEnumsTest.java index 676f61aa2c..b81871a92e 100644 --- a/test/edu/nps/moves/dis7/test/MarshalEnumsTest.java +++ b/test/edu/nps/moves/dis7/test/MarshalEnumsTest.java @@ -6,15 +6,15 @@ package edu.nps.moves.dis7.test; import edu.nps.moves.dis7.enumerations.*; import edu.nps.moves.dis7.pdus.DisBitSet; - import java.lang.reflect.Method; - import java.nio.ByteBuffer; - import org.junit.jupiter.api.*; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNull; +/** + * Unit tests for marshalling enumeration fields and values. + */ @DisplayName("Marshal Enums Test") public class MarshalEnumsTest { diff --git a/test/edu/nps/moves/dis7/test/NullFieldsEntityMarshallTest.java b/test/edu/nps/moves/dis7/test/NullFieldsEntityMarshallTest.java index 9f1c92c025..e88de9a9e0 100644 --- a/test/edu/nps/moves/dis7/test/NullFieldsEntityMarshallTest.java +++ b/test/edu/nps/moves/dis7/test/NullFieldsEntityMarshallTest.java @@ -11,8 +11,8 @@ import org.junit.jupiter.api.*; import static org.junit.jupiter.api.Assertions.*; /** - * NullFieldsMarshallTest created on May 20, 2019 MOVES Institute Naval Postgraduate School, Monterey, CA, USA www.nps.edu - * + * Unit tests for satisfactory handling of null fields and values when marshalling object instances. + * * @author Mike Bailey, jmbailey@edu.nps.edu * @version $Id$ */ diff --git a/test/edu/nps/moves/dis7/test/ObjectTypeMarshallTest.java b/test/edu/nps/moves/dis7/test/ObjectTypeMarshallTest.java index 50b1c7b5a4..ebff8149c7 100644 --- a/test/edu/nps/moves/dis7/test/ObjectTypeMarshallTest.java +++ b/test/edu/nps/moves/dis7/test/ObjectTypeMarshallTest.java @@ -12,6 +12,9 @@ import org.junit.jupiter.api.*; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNull; +/** + * Unit tests for satisfactory handling of typed fields and values when marshalling object instances. + */ @DisplayName("Object Type Marshal Test") public class ObjectTypeMarshallTest { diff --git a/test/edu/nps/moves/dis7/test/PduFactoryTest.java b/test/edu/nps/moves/dis7/test/PduFactoryTest.java index 25bde1cbce..2bf7fa7eb8 100644 --- a/test/edu/nps/moves/dis7/test/PduFactoryTest.java +++ b/test/edu/nps/moves/dis7/test/PduFactoryTest.java @@ -10,7 +10,8 @@ import org.junit.jupiter.api.*; import static org.junit.jupiter.api.Assertions.assertNull; /** - * + * Unit tests for satisfactory factory creation of each PDU class. + * * @author Mike Bailey, jmbailey@edu.nps.edu * @version $Id$ */ diff --git a/test/edu/nps/moves/dis7/test/X3dInterpolatorsTest.java b/test/edu/nps/moves/dis7/test/X3dInterpolatorsTest.java index 4bc745edfd..93e1548778 100644 --- a/test/edu/nps/moves/dis7/test/X3dInterpolatorsTest.java +++ b/test/edu/nps/moves/dis7/test/X3dInterpolatorsTest.java @@ -14,12 +14,12 @@ import java.nio.file.Path; import java.nio.file.StandardCopyOption; import java.util.concurrent.Semaphore; import org.junit.jupiter.api.AfterEach; -import org.junit.jupiter.api.Test; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; /** - * + * Unit tests for satisfactory filtering and creation of X3D interpolator values from a series of ESPDU track points. * @author <a href="mailto:tdnorbra@nps.edu?subject=edu.nps.moves.dis7.X3dInterpolatorsTest">Terry Norbraten, NPS MOVES</a> */ public class X3dInterpolatorsTest { -- GitLab