Adicionada documentação adicional

Author: tcpassos

file_encoder.log

@@ -29,19 +29,4 @@ public static int setBit(int data, int index) {
         return data | (1 << index);
     }
 
-    /**
-     * Converte um inteiro em um array de inteiros que podem assumir o valor de um ou zero
-     * Exemplo: 3 => [1, 0, 1]
-     * 
-     * @param bitset Valor a ser convertido
-     * @return {@code int[]}
-     */
-    public static int[] toBitArray(int bitset) {
-        int[] bitArray = new int[bitSetLength(bitset)];
-        for (int i=0; i<bitArray.length; i++) {
-            bitArray[i] = (bitset >> (bitArray.length - i - 1)) & 1;
-        }
-        return bitArray;
-    }
-    
 }

src/main/java/core/util/BitUtils.java

@@ -6,6 +6,13 @@
 
 public class FileUtils {
 
+    /**
+     * Verifica se a extensao de um arquivo corresponde a informada por parametro
+     *
+     * @param file Arquivo
+     * @param extennsionName Extensao a ser verificada
+     * @return {@code boolean}
+     */
     public static boolean checkExtensionName(File file, String extennsionName) {
         if (isNull(file)) {
             return false;
@@ -14,19 +21,45 @@ public static boolean checkExtensionName(File file, String extennsionName) {
         return extensionOpt.isPresent() && extensionOpt.get().equals(extennsionName);
     }
 
+    /**
+     * Retorna um novo arquivo com o mesmo nome do arquivo informado e com uma extensao diferente
+     *
+     * @param file Arquivo
+     * @param extension Nova extensao
+     * @return {@code File}
+     */
     public static File changeExtension(File file, String extension) {
         String filename = _getFileNameWithoutExtension(file) + "." + extension;
         return new File(file.getParent(), filename);
     }
 
+    /**
+     * Retorna um novo arquivo com o mesmo nome do arquivo informado concatenando uma nova extensao
+     *
+     * @param file Arquivo
+     * @param extension Extensao a ser concatenada
+     * @return {@code File}
+     */
     public static File appendExtension(File file, String extension) {
         return new File(file.getParent(), file.getName() + "." + extension);
     }
 
+    /**
+     * Retorna um novo arquivo com o mesmo nome do arquivo informado sem extensao
+     *
+     * @param file Arquivo
+     * @return {@code File}
+     */
     public static File removeExtension(File file) {
         return new File(file.getParent(), _getFileNameWithoutExtension(file));
     }
 
+    /**
+     * Retorna a extensao do arquivo a partir do seu nome
+     *
+     * @param filename Nome do arquivo
+     * @return {@code Optional<String>}
+     */
     public static Optional<String> getFileExtension(String filename) {
         return Optional.ofNullable(filename)
                 .filter(f -> f.contains("."))

src/main/java/core/util/FileUtils.java

@@ -4,6 +4,9 @@
 import java.io.InputStream;
 import java.io.OutputStream;
 
+/**
+ * Interface com metodos para a codificacao e decodificacao de uma stream de dados.
+ */
 public interface Encoder {
 
     public void encode(InputStream reader, OutputStream writer) throws IOException;

src/main/java/encoder/Encoder.java

@@ -2,6 +2,9 @@
 
 import java.util.Arrays;
 
+/**
+ * Tipos de codificacao disponiveis.
+ */
 public enum CodingType {
 
     GOLOMB("Golomb", 0),
@@ -10,7 +13,9 @@ public enum CodingType {
     UNARY("Unária", 3),
     DELTA("Delta", 4);
 
+    /* Descricao da codificacao */
     private String name;
+    /* Numero inteiro colocado no cabecalho do arquivo codificado */
     private int header;
 
     private CodingType(String name, int header) {

src/main/java/encoder/bean/CodingType.java

@@ -2,8 +2,17 @@
 
 import core.util.BitUtils;
 
+/**
+ * Classe responsavel pelo tratamento de erro CRC.
+ */
 public class CrcUtils implements PolynomialCodes {
 
+    /**
+     * Calcula o resto da divisao polinomial CRC-8 AMT
+     *
+     * @param data Informacao a ser dividida
+     * @return {@code int}
+     */
     public static int calculateCrc8(int data) {
         int shift = BitUtils.bitSetLength(data) - 1;
         int crc = (data << 8);
@@ -13,7 +22,14 @@ public static int calculateCrc8(int data) {
         }
         return crc & 0xFF;
     }
-    
+
+    /**
+     * Verifica se o resto da divisao polinomial CRC-8 esta de acordo com o esperado
+     *
+     * @param data Informacao a ser processada
+     * @param remainder Resto da divisao esperado
+     * @return {@code boolean}
+     */
     public static boolean checkCrc8(int data, int remainder) {
         return calculateCrc8(data) == remainder;
     }

src/main/java/errorcorrecting/crc/CrcUtils.java

@@ -1,5 +1,8 @@
 package errorcorrecting.crc;
 
+/**
+ * Constantes com os polinomiais utilizados na codificacao CRC.
+ */
 public interface PolynomialCodes {
 
     public final int POLYNOMIAL_CRC8_ATM = 0b100000111;

src/main/java/errorcorrecting/crc/PolynomialCodes.java

@@ -2,10 +2,19 @@
 
 import core.util.BitUtils;
 
+/**
+ * Classe responsavel pelo tratamento de erro Hamming.
+ */
 public class HammingUtils {
 
+    /**
+     * Retorna o codeword Hamming de 7 bits a partir de um simbolo de 4 bits
+     *
+     * @param symbol Simbolo a ser processado
+     * @return {@code int}
+     */
     public static int getCodeword(int symbol) {
-        // r1 r2 m1 r4 m2 m3 m4
+        // Sequencia codificada: r1 r2 m1 r4 m2 m3 m4
         int r1 = getFirstBitHamming(symbol) << 6;
         int r2 = getSecondBitHamming(symbol) << 5;
         int r4 = getThirdBitHamming(symbol) << 3;
@@ -14,13 +23,25 @@ public static int getCodeword(int symbol) {
         return r1 | r2 | r4 | m1 | m234;
     }
 
+    /**
+     * Retorna o simbolo decodificado de um codeword Hamming
+     *
+     * @param codeword Codeword Hamming
+     * @return {@code int}
+     */
     public static int parseCodeword(int codeword) {
         int m1 = (codeword >> 1) & 0b1000;
         int m234 = codeword & 0b0111;
         int symbol = m1 | m234;
         return symbol;
     }
 
+    /**
+     * Retorna o simbolo decodificado de um codeword Hamming corrigindo os bits inconsistentes
+     *
+     * @param codeword Codeword Hamming
+     * @return {@code int}
+     */
     public static int parseAndCorrectCodeword(int codeword) {
         int symbol = parseCodeword(codeword);
         int r1Check = ((codeword >> 6) & 1) ^ getFirstBitHamming(symbol);