Commit 08d369fe7d48914bcc612e7a9ef5230a5aba1e5c

Authored by Wesnydy Ribeiro
1 parent 3d15f561
Exists in master and in 1 other branch devel

Adiciona documentação do extratorVTT

Showing 1 changed file with 37 additions and 0 deletions   Show diff stats
extrator/src/include/extratorVTT.h
  1 +/**
  2 + * \file extratorVTT.h
  3 + *
  4 + * \author Wesnydy Ribeiro <wesnydy@lavid.ufpb.br>
  5 + * \date 2015
  6 + */
  7 +
1 8 #ifndef EXTRATORVTT_H
2 9 #define EXTRATORVTT_H
3 10  
... ... @@ -21,17 +28,47 @@ using namespace std;
21 28 using namespace sndesc;
22 29 using namespace jthread;
23 30  
  31 +/** \brief Classe que implementa o extrator de legenda.
  32 +*
  33 +* Instâncias desta classe extraem o conteúdo de
  34 +* arquivos webVTT.
  35 +*
  36 +* \headerfile extrator/src/include/extratorVTT.h
  37 +*/
24 38 class ExtratorVTT: public Extrator, public Thread {
25 39  
26 40 public:
  41 + /** Construtor */
27 42 ExtratorVTT();
  43 +
  44 + /** Destrutor */
28 45 ~ExtratorVTT();
29 46  
  47 + /** Define o path do arquivo de entrada.
  48 + *
  49 + * \param path O path do arquivo.
  50 + */
30 51 void setFilePath(char* path);
  52 +
  53 + /** Adiciona ouvintes do extratorVTT.
  54 + *
  55 + * \param listener O ouvinte a ser registrado.
  56 + */
31 57 void addListener(ListenerSub* listener);
32 58  
  59 + /** Inicializa o processo de extração da legendas.
  60 + *
  61 + * \exception ExtratorException caso o arquivo de legenda não seja encontrado.
  62 + */
33 63 void initialize();
  64 +
  65 + /** Indica o fim do processo de extração das legendas.
  66 + *
  67 + * \return O status do do processo.
  68 + */
34 69 bool isFinished();
  70 +
  71 + /** Este método é chamado quando a Thread for iniciada. */
35 72 void Run();
36 73  
37 74 private:
... ...