Skip to content

Commit ed689c5

Browse files
committed
[Java]: Fix javadoc warnings on Java 8.
1 parent 11d23c0 commit ed689c5

25 files changed

+71
-179
lines changed

main/csharp/Otf/OtfHeaderDecoder.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ namespace Adaptive.SimpleBinaryEncoding.Otf
44
{
55
/// <summary>
66
/// Used to decode a message header while doing on-the-fly decoding of a message stream.
7-
/// <p/>
7+
///
88
/// Meta data is cached to improve the performance of decoding headers.
9-
/// <p/>
9+
///
1010
/// This class is thread safe.
1111
/// </summary>
1212
public class OtfHeaderDecoder

main/csharp/PrimitiveType.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/// <summary>
44
/// Primitive types from which all other types are composed.
55
///
6-
/// <p/>
6+
///
77
/// <table>
88
/// <thead>
99
/// <tr>

main/csharp/ir/IntermediateRepresentation.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ public int Id
136136

137137
/// <summary>
138138
/// Get the namespaceName to be used for generated code.
139-
/// <p/>
139+
///
140140
/// If <seealso cref="NamespaceName"/> is null then <seealso cref="PackageName"/> is used.
141141
/// </summary>
142142
/// <returns> the namespaceName to be used for generated code. </returns>

main/csharp/ir/Token.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ namespace Adaptive.SimpleBinaryEncoding.ir
2222
/// <summary>
2323
/// Class to encapsulate a token of information for the message schema stream. This Intermediate Representation (IR)
2424
/// is intended to be language, schema, platform independent.
25-
/// <p/>
25+
///
2626
/// Processing and optimization could be run over a list of Tokens to perform various functions
2727
/// <ul>
2828
/// <li>re-ordering of fields based on size</li>
2929
/// <li>padding of fields in order to provide expansion room</li>
3030
/// <li>computing offsets of individual fields</li>
3131
/// <li>etc.</li>
3232
/// </ul>
33-
/// <p/>
33+
///
3434
/// IR could be used to generate code or other specifications. It should be possible to do the
3535
/// following:
3636
/// <ul>
@@ -39,18 +39,18 @@ namespace Adaptive.SimpleBinaryEncoding.ir
3939
/// <li>generate a GPB spec from IR</li>
4040
/// <li>etc.</li>
4141
/// </ul>
42-
/// <p/>
42+
///
4343
/// IR could be serialized to storage or network via code generated by SBE. Then read back in to
4444
/// a List of <seealso cref="Token"/>s.
45-
/// <p/>
45+
///
4646
/// The entire IR of an entity is a <see cref="List{Token}"/>. The order of this list is
4747
/// very important. Encoding of fields is done by nodes pointing to specific encoding <seealso cref="PrimitiveType"/>
4848
/// objects. Each encoding node contains size, offset, byte order, and <seealso cref="Encoding"/>. Entities relevant
4949
/// to the encoding such as fields, messages, repeating groups, etc. are encapsulated in the list as nodes
5050
/// themselves. Although, they will in most cases never be serialized. The boundaries of these entities
5151
/// are delimited by BEGIN and END <seealso cref="Adaptive.SimpleBinaryEncoding.ir.Signal"/> values in the node <seealso cref="Encoding"/>.
5252
/// A list structure like this allows for each concatenation of encodings as well as easy traversal.
53-
/// <p/>
53+
///
5454
/// An example encoding of a message headerStructure might be like this.
5555
/// <ul>
5656
/// <li>Token 0 - Signal = BEGIN_MESSAGE, schemaId = 100</li>
@@ -59,7 +59,7 @@ namespace Adaptive.SimpleBinaryEncoding.ir
5959
/// <li>Token 3 - Signal = END_FIELD</li>
6060
/// <li>Token 4 - Signal = END_MESSAGE</li>
6161
/// </ul>
62-
/// <p/>
62+
///
6363
/// </summary>
6464
public class Token
6565
{

main/java/uk/co/real_logic/sbe/PrimitiveType.java

Lines changed: 0 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -18,74 +18,6 @@
1818

1919
/**
2020
* Primitive types from which all other types are composed.
21-
*
22-
* <p/>
23-
* <table>
24-
* <thead>
25-
* <tr>
26-
* <th>PrimitiveType Type</th>
27-
* <th>Description</th>
28-
* <th>Length (octets)</th>
29-
* </tr>
30-
* </thead>
31-
* <tbody>
32-
* <tr>
33-
* <td>char</td>
34-
* <td>Character</td>
35-
* <td>1</td>
36-
* </tr>
37-
* <tr>
38-
* <td>int8</td>
39-
* <td>Signed byte</td>
40-
* <td>1</td>
41-
* </tr>
42-
* <tr>
43-
* <td>uint8</td>
44-
* <td>Unsigned Byte / single byte character</td>
45-
* <td>1</td>
46-
* </tr>
47-
* <tr>
48-
* <td>int16</td>
49-
* <td>Signed integer</td>
50-
* <td>2</td>
51-
* </tr>
52-
* <tr>
53-
* <td>uint16</td>
54-
* <td>Unsigned integer</td>
55-
* <td>2</td>
56-
* </tr>
57-
* <tr>
58-
* <td>int32</td>
59-
* <td>Signed integer</td>
60-
* <td>4</td>
61-
* </tr>
62-
* <tr>
63-
* <td>uint32</td>
64-
* <td>Unsigned integer</td>
65-
* <td>4</td>
66-
* </tr>
67-
* <tr>
68-
* <td>int64</td>
69-
* <td>Signed integer</td>
70-
* <td>8</td>
71-
* </tr>
72-
* <tr>
73-
* <td>uint64</td>
74-
* <td>Unsigned integer</td>
75-
* <td>8</td>
76-
* </tr>
77-
* <tr>
78-
* <td>float</td>
79-
* <td>Single precision floating point</td>
80-
* <td>4</td>
81-
* </tr>
82-
* <tr>
83-
* <td>double</td>
84-
* <td>Double precision floating point</td>
85-
* <td>8</td>
86-
* </tr>
87-
* </tbody>
88-
* </table>
8921
*/
9022
public enum PrimitiveType
9123
{

main/java/uk/co/real_logic/sbe/PrimitiveValue.java

Lines changed: 5 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -25,74 +25,6 @@
2525

2626
/**
2727
* Class used to encapsulate values for primitives. Used for nullValue, minValue, maxValue, and constants
28-
* <p/>
29-
*
30-
* <table>
31-
* <thead>
32-
* <tr>
33-
* <th>PrimitiveType</th>
34-
* <th>Null</th>
35-
* <th>Min</th>
36-
* <th>Max</th>
37-
* </tr>
38-
* </thead>
39-
* <tbody>
40-
* <tr>
41-
* <td>char</td>
42-
* <td>0</td>
43-
* <td>0x20</td>
44-
* <td>0x7E</td>
45-
* </tr>
46-
* <tr>
47-
* <td>int8</td>
48-
* <td>-128</td>
49-
* <td>-127</td>
50-
* <td>127</td>
51-
* </tr>
52-
* <tr>
53-
* <td>uint8</td>
54-
* <td>255</td>
55-
* <td>0</td>
56-
* <td>254</td>
57-
* </tr>
58-
* <tr>
59-
* <td>int16</td>
60-
* <td>-32768</td>
61-
* <td>-32767</td>
62-
* <td>32767</td>
63-
* </tr>
64-
* <tr>
65-
* <td>uint16</td>
66-
* <td>65535</td>
67-
* <td>0</td>
68-
* <td>65534</td>
69-
* </tr>
70-
* <tr>
71-
* <td>int32</td>
72-
* <td>2^31</td>
73-
* <td>-2^31 + 1</td>
74-
* <td>2^31 - 1</td>
75-
* </tr>
76-
* <tr>
77-
* <td>uint32</td>
78-
* <td>2^32 - 1</td>
79-
* <td>0</td>
80-
* <td>2^32 - 2</td>
81-
* </tr>
82-
* <tr>
83-
* <td>int64</td>
84-
* <td>2^63</td>
85-
* <td>-2^63 + 1</td>
86-
* <td>2^63 - 1</td>
87-
* </tr>
88-
* <tr>
89-
* <td>uint64</td>
90-
* <td>2^64 - 1</td>
91-
* <td>0</td>
92-
* <td>2^64 - 2</td>
93-
* </tr>
94-
* </tbody>
95-
* </table>
9628
*/
9729
public class PrimitiveValue
9830
{
@@ -161,6 +93,7 @@ public enum Representation
16193
* Construct and fill in value as a long.
16294
*
16395
* @param value in long format
96+
* @param size of the type in bytes
16497
*/
16598
public PrimitiveValue(final long value, final int size)
16699
{
@@ -174,7 +107,9 @@ public PrimitiveValue(final long value, final int size)
174107

175108
/**
176109
* Construct and fill in value as a double.
110+
*
177111
* @param value in double format
112+
* @param size of the type in bytes
178113
*/
179114
public PrimitiveValue(final double value, final int size)
180115
{
@@ -190,6 +125,8 @@ public PrimitiveValue(final double value, final int size)
190125
* Construct and fill in value as a byte array.
191126
*
192127
* @param value as a byte array
128+
* @param characterEncoding of the characters
129+
* @param size of string in characters
193130
*/
194131
public PrimitiveValue(final byte[] value, final String characterEncoding, final int size)
195132
{

main/java/uk/co/real_logic/sbe/SbeTool.java

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,14 @@
3131

3232
/**
3333
* A tool for running the SBE parser, validator, and code generator.
34-
* <p/>
34+
*
3535
* Usage:
36-
* <code>
37-
* <pre>
36+
* <pre>
3837
* $ java -jar sbe.jar &lt;filename.xml&gt;
3938
* $ java -Doption=value -jar sbe.jar &lt;filename.xml&gt;
4039
* $ java -Doption=value -jar sbe.jar &lt;filename.sbeir&gt;
41-
* </pre>
42-
* </code>
43-
* <p/>
40+
* </pre>
41+
*
4442
* Properties
4543
* <ul>
4644
* <li><code>sbe.validation.xsd</code>: Use XSD to validate or not.</li>

main/java/uk/co/real_logic/sbe/codec/java/DirectBuffer.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -509,6 +509,7 @@ public int putBytes(final int index, final byte[] src, final int offset, final i
509509
*
510510
* @param index in the underlying buffer to start from.
511511
* @param srcBuffer to copy the bytes from.
512+
* @param length of the source buffer in bytes to copy
512513
* @return count of bytes copied.
513514
*/
514515
public int putBytes(final int index, final ByteBuffer srcBuffer, final int length)

main/java/uk/co/real_logic/sbe/generation/OutputManager.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ public interface OutputManager
2929
*
3030
* @param name of the given output.
3131
* @return A {@link Writer} to which the code generation should be output.
32+
* @throws IOException if an error occurs during output.
3233
*/
3334
Writer createOutput(final String name) throws IOException;
3435
}

main/java/uk/co/real_logic/sbe/generation/cpp98/NamespaceOutputManager.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ public class NamespaceOutputManager implements OutputManager
3333
*
3434
* @param baseDirectoryName for the generated source code.
3535
* @param namespaceName for the generated source code relative to the baseDirectoryName.
36+
* @throws IOException if an error occurs during output
3637
*/
3738
public NamespaceOutputManager(final String baseDirectoryName, final String namespaceName)
3839
throws IOException
@@ -56,7 +57,7 @@ public NamespaceOutputManager(final String baseDirectoryName, final String names
5657

5758
/**
5859
* Create a new output which will be a C++98 source file in the given package.
59-
* <p/>
60+
*
6061
* The {@link java.io.Writer} should be closed once the caller has finished with it. The Writer is
6162
* buffer for efficient IO operations.
6263
*

0 commit comments

Comments
 (0)