diff --git a/doc_config b/doc_config index 948b59f..7d9d2d6 100644 --- a/doc_config +++ b/doc_config @@ -648,7 +648,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = extrator/src/include servico/src/include renderer/src/include mixer/src/include util/src/include +INPUT = extrator/src/include servico/src/include renderer/src/include mixer/src/include util/src/include tradutor/src/include # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is diff --git a/tradutor/src/include/listenerTradutor.h b/tradutor/src/include/listenerTradutor.h index 63af315..5e69c10 100644 --- a/tradutor/src/include/listenerTradutor.h +++ b/tradutor/src/include/listenerTradutor.h @@ -1,9 +1,10 @@ -/* - * File: ouvinteTradutor.h - * Author: derzu - * - * Created on 2 de Fevereiro de 2010, 15:48 +/** + * \file listenerTradutor.h + * + * \author Derzu Omaia + * \date 02/02/2010 */ + #ifndef _LISTENERTRADUTOR_H #define _LISTENERTRADUTOR_H @@ -14,10 +15,6 @@ namespace Tradutor { class ListenerTradutor { public: - //OuvinteTradutor(); - //virtual ~OuvinteTradutor(); - - // Metodo que vai ser chamado quando chegar a traducao virtual void notifyTranslation(char* glosa) = 0; }; diff --git a/tradutor/src/include/pyTradutor.h b/tradutor/src/include/pyTradutor.h index 0644b3b..c471454 100644 --- a/tradutor/src/include/pyTradutor.h +++ b/tradutor/src/include/pyTradutor.h @@ -8,7 +8,8 @@ //***************************************************************** /** - * \file pyTradutor.hpp + * \file pyTradutor.h + * * \authors Erickson Silva, Gustavo Sobral * \date Janeiro 2015 */ @@ -20,6 +21,8 @@ * Essa classe permite a execução e comunição do Tradutor * (Português -> Glosa) do sistema escrito em Python * permitindo sua utilização numa aplicação C++. + * + * \headerfile tradutor/src/include/pyTradutor.h */ class PyTradutor { @@ -32,19 +35,19 @@ private: PyObject * pResult; public: - /** \brief O construtor da classe + /** O construtor da classe * * O construtor inicia o ambiente Python para execução da tradução do tradutor. */ PyTradutor(); - /** \brief O destrutor da classe + /** O destrutor da classe * * O Destrutor finaliza o ambiente Python montado para execução da tradução. */ ~PyTradutor(); - /** \brief Converte Português para Glosa + /** Converte Português para Glosa * * Converte a string de entrada em Português para Glosa * através da execução do Tradutor e retorna esse resultado diff --git a/tradutor/src/include/tradutorPortGlosa.h b/tradutor/src/include/tradutorPortGlosa.h index 634f2a3..29c25f2 100644 --- a/tradutor/src/include/tradutorPortGlosa.h +++ b/tradutor/src/include/tradutorPortGlosa.h @@ -1,17 +1,10 @@ /** - * edit: - * @author Erickson Silva - * @date 14/10/2013 + * \file tradutorPortGlosa.h * + * \authors Derzu Omaia, Erickson Silva + * \date 14/10/2013 */ -/** - * Essa classe converte portugues para Glosa - * - * @author Derzu Omaia - * @date 21/10/2009 - * - */ #include #include #include @@ -28,23 +21,62 @@ using namespace util; namespace Tradutor { + /** \brief classe para conversão de português para glosa + * + * \headerfile tradutor/src/include/tradutorPortGlosa.h + */ class TradutorPortGlosa : public ListenerInput{ public: + + /** Construtor. */ TradutorPortGlosa(); + + /** Destrutor. */ virtual ~TradutorPortGlosa(); + + /** + * Traduz um texto (char* input) para um vetor de tokens contendo a + * traducao para glosa. + * + * \param input texto de entrada. + * \return Vetor de string contendo os tokens em glosa traduzidos. + */ char* portuguesToGlosaVector(const char * input); - // Adiciona + /** Adiciona ouvintes do tradutorPortGlosa. + * + * \param listener O ouvinte a ser registrado. + */ void addListener(ListenerTradutor * listener); - // Remove + + /** Remove ouvintes do tradutorPortGlosa. + * + * \param listener O ouvinte a ser removido. + */ void removeListener(ListenerTradutor * listener); + /** Traduz o portugues para glosa. + * + * Traduz o texto de portugues para glosa e notifica os ouvintes + * após a tradução. + * + * \param texto O texto a ser traduzido. + */ void traduz(unsigned char * texto); + + /** Invoca os notificadores. + * + * Após a tradução, os ouvintes são notificados + * sobre a nova glosa. + * + * \param texto O texto para a tradução. + */ virtual void notifyInput(unsigned char * texto); //virtual void notificaCC(unsigned char * cc, int64_t pts); private: + /** Notifica os ouvintes sobre o fim da tradução. */ void notifyListeners(char* traducao); std::list * listeners; -- libgit2 0.21.2