ben/brouter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Fix JavaDoc errors

Browse source
This commit is contained in:
Phyks (Lucas Verney) 2018-12-04 17:23:28 +01:00
parent d621964863
commit 780e865870
14 changed files with 124 additions and 128 deletions
Download patch file Download diff file Expand all files Collapse all files

14
brouter-map-creator/src/main/java/btools/mapdecoder/BitReadBuffer.java
View file

@ -14,7 +14,7 @@ public final class BitReadBuffer
this.ab = ab;
idxMax = ab.length-1;
}
public boolean decodeBit()
{
fillBuffer();
@ -60,10 +60,10 @@ public final class BitReadBuffer
/**
* decode a small number with a variable bit length
* (poor mans huffman tree)
* 1 -> 0
* 01 -> 1 + following 1-bit word ( 1..2 )
* 001 -> 3 + following 2-bit word ( 3..6 )
* 0001 -> 7 + following 3-bit word ( 7..14 ) etc.
* {@code 1 -> 0}
* {@code 01 -> 1} + following 1-bit word ( 1..2 )
* {@code 001 -> 3} + following 2-bit word ( 3..6 )
* {@code 0001 -> 7} + following 3-bit word ( 7..14 ) etc.
*/
public int decodeInt()
{
@ -139,7 +139,7 @@ public final class BitReadBuffer
}
}
private void fillBuffer()
{
while (bits <= 56)
@ -150,5 +150,5 @@ public final class BitReadBuffer
}
bits += 8;
}
}
}
}

21
brouter-map-creator/src/main/java/btools/mapsplitter/BitWriteBuffer.java
View file

@ -23,12 +23,13 @@ public final class BitWriteBuffer
/**
* encode a distance with a variable bit length
* (poor mans huffman tree)
* 1 -> 0
* 01 -> 1 + following 1-bit word ( 1..2 )
* 001 -> 3 + following 2-bit word ( 3..6 )
* 0001 -> 7 + following 3-bit word ( 7..14 ) etc.
*
* @see #decodeVarBits
* {@code 1 -> 0}
* {@code 01 -> 1} + following 1-bit word ( 1..2 )
* {@code 001 -> 3} + following 2-bit word ( 3..6 )
* {@code 0001 -> 7} + following 3-bit word ( 7..14 ) etc.
*
* @see btools.util.BitCoderContext#decodeVarBits
*
*/
public void encodeInt( int value )
{
@ -39,7 +40,7 @@ public final class BitWriteBuffer
value -= range + 1;
range = 2 * range + 1;
}
encodeBit( true );
encodeBounded( range, value );
}
@ -127,7 +128,7 @@ public final class BitWriteBuffer
if ( size == 0 )
{
return;
}
}
long maxValue = values[size-1];
int nbits = 0;
while ( maxValue > 0 )
@ -187,7 +188,7 @@ public final class BitWriteBuffer
/**
* assign the de-/encoded bits since the last call assignBits to the given
* name. Used for encoding statistics
*
*
* @see #getBitReport
*/
public void assignBits( String name )
@ -210,7 +211,7 @@ public final class BitWriteBuffer
/**
* Get a textual report on the bit-statistics
*
*
* @see #assignBits
*/
public static String getBitReport()

6
brouter-map-creator/src/main/java/btools/mapsplitter/HuffmanTreeEncoder.java
View file

@ -10,7 +10,7 @@ import java.util.PriorityQueue;
* It detects identical sets and sorts them
* into a huffman-tree according to their frequencies
*
* Adapted for 3-pass encoding (counters -> statistics -> encoding )
* Adapted for 3-pass encoding (counters -&gt; statistics -&gt; encoding )
* but doesn't do anything at pass1
*/
public abstract class HuffmanTreeEncoder<V>
@ -124,10 +124,10 @@ public abstract class HuffmanTreeEncoder<V>
}
}
}
@Override
public boolean equals( Object o )
{
{
return itemEquals( ((TreeNode)o).data, data );
}

4
brouter-map-creator/src/main/java/btools/mapsplitter/TagSetEncoder.java
View file

@ -10,7 +10,7 @@ import java.util.PriorityQueue;
* It detects identical sets and sorts them
* into a huffman-tree according to their frequencies
*
* Adapted for 3-pass encoding (counters -> statistics -> encoding )
* Adapted for 3-pass encoding (counters -&gt; statistics -&gt; encoding )
* but doesn't do anything at pass1
*/
public final class TagSetEncoder
@ -131,7 +131,7 @@ public final class TagSetEncoder
}
}
}
@Override
public boolean equals( Object o )
{