Commit 4c457d7f3bab205435c93deccad154e1e446d3b2
1 parent
7ebeef0d
Exists in
master
and in
1 other branch
Adiciona documentação do tradutor
Showing
4 changed files
with
58 additions
and
26 deletions
Show diff stats
doc_config
... | ... | @@ -648,7 +648,7 @@ WARN_LOGFILE = |
648 | 648 | # directories like "/usr/src/myproject". Separate the files or directories |
649 | 649 | # with spaces. |
650 | 650 | |
651 | -INPUT = extrator/src/include servico/src/include renderer/src/include mixer/src/include util/src/include | |
651 | +INPUT = extrator/src/include servico/src/include renderer/src/include mixer/src/include util/src/include tradutor/src/include | |
652 | 652 | |
653 | 653 | # This tag can be used to specify the character encoding of the source files |
654 | 654 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is | ... | ... |
tradutor/src/include/listenerTradutor.h
1 | -/* | |
2 | - * File: ouvinteTradutor.h | |
3 | - * Author: derzu | |
4 | - * | |
5 | - * Created on 2 de Fevereiro de 2010, 15:48 | |
1 | +/** | |
2 | + * \file listenerTradutor.h | |
3 | + * | |
4 | + * \author Derzu Omaia | |
5 | + * \date 02/02/2010 | |
6 | 6 | */ |
7 | + | |
7 | 8 | #ifndef _LISTENERTRADUTOR_H |
8 | 9 | #define _LISTENERTRADUTOR_H |
9 | 10 | |
... | ... | @@ -14,10 +15,6 @@ namespace Tradutor { |
14 | 15 | |
15 | 16 | class ListenerTradutor { |
16 | 17 | public: |
17 | - //OuvinteTradutor(); | |
18 | - //virtual ~OuvinteTradutor(); | |
19 | - | |
20 | - // Metodo que vai ser chamado quando chegar a traducao | |
21 | 18 | virtual void notifyTranslation(char* glosa) = 0; |
22 | 19 | }; |
23 | 20 | ... | ... |
tradutor/src/include/pyTradutor.h
... | ... | @@ -8,7 +8,8 @@ |
8 | 8 | //***************************************************************** |
9 | 9 | |
10 | 10 | /** |
11 | - * \file pyTradutor.hpp | |
11 | + * \file pyTradutor.h | |
12 | + * | |
12 | 13 | * \authors Erickson Silva, Gustavo Sobral |
13 | 14 | * \date Janeiro 2015 |
14 | 15 | */ |
... | ... | @@ -20,6 +21,8 @@ |
20 | 21 | * Essa classe permite a execução e comunição do Tradutor |
21 | 22 | * (Português -> Glosa) do sistema escrito em Python |
22 | 23 | * permitindo sua utilização numa aplicação C++. |
24 | + * | |
25 | + * \headerfile tradutor/src/include/pyTradutor.h | |
23 | 26 | */ |
24 | 27 | class PyTradutor |
25 | 28 | { |
... | ... | @@ -32,19 +35,19 @@ private: |
32 | 35 | PyObject * pResult; |
33 | 36 | public: |
34 | 37 | |
35 | - /** \brief O construtor da classe | |
38 | + /** O construtor da classe | |
36 | 39 | * |
37 | 40 | * O construtor inicia o ambiente Python para execução da tradução do tradutor. |
38 | 41 | */ |
39 | 42 | PyTradutor(); |
40 | 43 | |
41 | - /** \brief O destrutor da classe | |
44 | + /** O destrutor da classe | |
42 | 45 | * |
43 | 46 | * O Destrutor finaliza o ambiente Python montado para execução da tradução. |
44 | 47 | */ |
45 | 48 | ~PyTradutor(); |
46 | 49 | |
47 | - /** \brief Converte Português para Glosa | |
50 | + /** Converte Português para Glosa | |
48 | 51 | * |
49 | 52 | * Converte a string de entrada em Português para Glosa |
50 | 53 | * através da execução do Tradutor e retorna esse resultado | ... | ... |
tradutor/src/include/tradutorPortGlosa.h
1 | 1 | /** |
2 | - * edit: | |
3 | - * @author Erickson Silva | |
4 | - * @date 14/10/2013 | |
2 | + * \file tradutorPortGlosa.h | |
5 | 3 | * |
4 | + * \authors Derzu Omaia, Erickson Silva | |
5 | + * \date 14/10/2013 | |
6 | 6 | */ |
7 | 7 | |
8 | -/** | |
9 | - * Essa classe converte portugues para Glosa | |
10 | - * | |
11 | - * @author Derzu Omaia | |
12 | - * @date 21/10/2009 | |
13 | - * | |
14 | - */ | |
15 | 8 | #include <iostream> |
16 | 9 | #include <list> |
17 | 10 | #include <pthread.h> |
... | ... | @@ -28,23 +21,62 @@ using namespace util; |
28 | 21 | |
29 | 22 | namespace Tradutor { |
30 | 23 | |
24 | + /** \brief classe para conversão de português para glosa | |
25 | + * | |
26 | + * \headerfile tradutor/src/include/tradutorPortGlosa.h | |
27 | + */ | |
31 | 28 | class TradutorPortGlosa : public ListenerInput{ |
32 | 29 | public: |
30 | + | |
31 | + /** Construtor. */ | |
33 | 32 | TradutorPortGlosa(); |
33 | + | |
34 | + /** Destrutor. */ | |
34 | 35 | virtual ~TradutorPortGlosa(); |
36 | + | |
37 | + /** | |
38 | + * Traduz um texto (char* input) para um vetor de tokens<string> contendo a | |
39 | + * traducao para glosa. | |
40 | + * | |
41 | + * \param input texto de entrada. | |
42 | + * \return Vetor de string contendo os tokens em glosa traduzidos. | |
43 | + */ | |
35 | 44 | char* portuguesToGlosaVector(const char * input); |
36 | 45 | |
37 | - // Adiciona | |
46 | + /** Adiciona ouvintes do tradutorPortGlosa. | |
47 | + * | |
48 | + * \param listener O ouvinte a ser registrado. | |
49 | + */ | |
38 | 50 | void addListener(ListenerTradutor * listener); |
39 | - // Remove | |
51 | + | |
52 | + /** Remove ouvintes do tradutorPortGlosa. | |
53 | + * | |
54 | + * \param listener O ouvinte a ser removido. | |
55 | + */ | |
40 | 56 | void removeListener(ListenerTradutor * listener); |
41 | 57 | |
58 | + /** Traduz o portugues para glosa. | |
59 | + * | |
60 | + * Traduz o texto de portugues para glosa e notifica os ouvintes | |
61 | + * após a tradução. | |
62 | + * | |
63 | + * \param texto O texto a ser traduzido. | |
64 | + */ | |
42 | 65 | void traduz(unsigned char * texto); |
66 | + | |
67 | + /** Invoca os notificadores. | |
68 | + * | |
69 | + * Após a tradução, os ouvintes são notificados | |
70 | + * sobre a nova glosa. | |
71 | + * | |
72 | + * \param texto O texto para a tradução. | |
73 | + */ | |
43 | 74 | virtual void notifyInput(unsigned char * texto); |
44 | 75 | //virtual void notificaCC(unsigned char * cc, int64_t pts); |
45 | 76 | |
46 | 77 | |
47 | 78 | private: |
79 | + /** Notifica os ouvintes sobre o fim da tradução. */ | |
48 | 80 | void notifyListeners(char* traducao); |
49 | 81 | |
50 | 82 | std::list<ListenerTradutor*> * listeners; | ... | ... |