Mini Projeto

Esse é um exemplo de projeto bem básico que utiliza todas as ferramentas e utilitários vistos ao longo da disciplina. Ele pode ser melhorado em diferentes aspectos e portanto não deve ser visto como um guia definitivo a ser seguido.

Ferramentas

Esse projeto utiliza as seguintes linguagem, ferramentas e bibliotecas:

• Linguagem: C++11
• Compilação: Make
• Documentação: Doxygen
• Testes Unitários: Doctest
• Cobertura: gcovr

Compilação

$ make

Atenção: Criar antes um diretório ./build/

Execução

$ make run

Compilação Testes

$ make tests

Execução Testes

$ make run_tests

Relatório de Cobertura

Para imprimir o relatório simplificado no próprio Terminal, utilizar:

$ make coverage

Para gerar o relatório em HTML, utilizar:

$ make html_coverage

Atenção: Criar antes um diretório ./coverage/

Documentação

É necessário ter na raiz do projeto um arquivo Doxyfile. Um arquivo padrão pode ser gerado pelo comando:

$ doxygen -g

Abaixo a lista de flags que foram modificadas no arquivo original.

PROJECT_NAME           = "PDS2 - Mini-projeto de exemplo"

OUTPUT_DIRECTORY       = doc/

RECURSIVE              = YES

EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES

HAVE_DOT               = NO

Para gerar a documentação, utilizar:

$ doxygen Doxyfile

ou

$ make documentation

Atenção: Criar antes um diretório ./doc/

Remover arquivos auxiliares

$ make clean