From 40a0bfdba094eb8dcf13b815507c42deb524373f Mon Sep 17 00:00:00 2001
From: Wesnydy Ribeiro <wesnydy@lavid.ufpb.br>
Date: Mon, 5 Oct 2015 09:14:37 -0300
Subject: [PATCH] Documentação do componente 'util'

---
 util/src/include/argParser.h | 108 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 util/src/include/logging.h   |  23 +++++++++++++++++++++++
 2 files changed, 131 insertions(+), 0 deletions(-)

diff --git a/util/src/include/argParser.h b/util/src/include/argParser.h
index 0c8eccc..93d2884 100644
--- a/util/src/include/argParser.h
+++ b/util/src/include/argParser.h
@@ -1,3 +1,10 @@
+/**
+ * \file argParser.h
+ *
+ * \author Wesnydy Lima Ribeiro <wesnydy@lavid.ufpb.br>
+ * \date 2015
+ */
+
 #ifndef ARG_PARSER_H
 #define ARG_PARSER_H
 
@@ -15,23 +22,90 @@
 using namespace std;
 using namespace util;
 
+/** \brief Analizador de argumentos de linha de comando.
+ *
+ * \headerfile util/src/include/argParser.h
+ */
 class ArgParser {
 public:
+	/** Construtor */
 	ArgParser();
+
+	/** Destrutor */
 	~ArgParser();
+
+	/** Analiza os argumentos da linha de comando.
+	 *
+	 * \param argv Os argumentos.
+	 * \param arc O número de argumentos.
+	 * \exception RuntimeException Se forem encontrados argumentos inválidos ou na falta de argumentos.
+	 */
 	void readArgs(char** argv, int argc);
 
+	/** Retorna o serviço requisitado.
+	 *
+	 * \return O serviço.
+	 */
 	int getService();
+
+	/** Retorna a linguagem do arquivo de entrada.
+	 *
+	 * \return A linguagem do arquivo.
+	 */
 	int getLanguage();
+
+	/** Retorna a posição do vídeo de LIBRAS.
+	 *
+	 * \return A posição do vídeo.
+	 */
 	int getPosition();
+
+	/** Retorna o tamanho do vídeo de LIBRAS.
+	 *
+	 * \return O tamanho do vídeo.
+	 */
 	int getSize();
+
+	/** Retorna a transparência do plano de fundo.
+	 *
+	 * \return O background do vídeo.
+	 */
 	int getBackground();
+
+	/** Retorna o modo de execução.
+	 *
+	 * \return O modo de execução.
+	 */
 	int getMode();
+
+	/** Retorna opções extras ativadas.
+	 *
+	 * \return A opção extra.
+	 */
 	int getOption();
 
+	/** Retorna o path arquivo de entrada.
+	 *
+	 * \return O path do arquivo.
+	 */
 	string getInput();
+
+	/** Retorna o path arquivo de legendas.
+	 *
+	 * \return O path do arquivo de legendas.
+	 */
 	string getInputSRT();
+
+	/** Retorna a identificação do cliente.
+	 *
+	 * \return O ID do cliente.
+	 */
 	string getId();
+
+	/** Retorna o nível de log selecionado.
+	 *
+	 * 	\return O nível do log.
+	 */
 	util::logLevel getLog();
 
 private:
@@ -57,12 +131,46 @@ private:
 		util::logLevel l_level;
 	}globalArgs;
 
+	/** Exibe erros ocorridos durante a analise dos argumentos.
+	 *
+	 * \param option A mensagem de erro.
+	 */
 	void returnErr(const string& option);
+
+	/** Retorna a opção de linguagem a partir de uma string.
+	 *
+	 * \return A linguagem do arquivo.
+	 */
 	Languages  languageFromString(const string& language);
+
+	/** Retorna a opção de posição a partir de uma string.
+	 *
+	 * \return A posição do vídeo.
+	 */
 	Positions  positionFromString(const string& position);
+
+	/** Retorna a opção de resolução a partir de uma string.
+	 *
+	 * \return A resolução do vídeo.
+	 */
 	Resolution resolutionFromString(const string& resolution);
+
+	/** Retorna a opção de background a partir de uma string.
+	 *
+	 * \return O background do vídeo.
+	 */
 	Background backgroundFromString(const string& backg);
+
+	/** Retorna a opção do modo de execução a partir de uma string.
+	 *
+	 * \return O modo de execução.
+	 */
 	Mode executionModeFromString(const string& mode);
+
+	/** Retorna o nível de log selecionado.
+	 *
+	 * \return O nível de log.
+	 */
 	util::logLevel logFromString(const string& level);
 };
 
diff --git a/util/src/include/logging.h b/util/src/include/logging.h
index bdd57f0..0d363ba 100644
--- a/util/src/include/logging.h
+++ b/util/src/include/logging.h
@@ -1,3 +1,10 @@
+/**
+ * \file logging.h
+ *
+ * \author Wesnydy Lima Ribeiro <wesnydy@lavid.ufpb.br>
+ * \date 2015
+ */
+
 #ifndef LOGGING_H
 #define LOGGING_H
 
@@ -17,11 +24,27 @@ namespace util {
 
 	enum logLevel { _QUIET = 1 , _ERROR, _WARNING, _INFO, _DEBUG};
 
+	/** \brief Classe responsável pelo log exibido no terminal.
+	 *
+	 * \headerfile util/src/include/logging.h
+	 */
 	class Logging {
 	public:
 		static Logging* instance();
+
+		/** Retorna o nível de log selecionado.
+		 *
+		 * \return O nível de log.
+		 */
 		logLevel getLevel();
+
+		/** Seta o nível de log, no terminal. */
 		void setLevel(logLevel level);
+
+		/** Escreve o log em um arquivo.
+		 *
+		 * \param logMsg A mensagem do log.
+		 */
 		void writeLog(const char* logMsg);
 
 	private:
--
libgit2 0.21.2