0% acharam este documento útil (0 voto)
5 visualizações23 páginas

Relatório de Projeto em Engenharia Informática

O relatório documenta o trabalho realizado por um grupo de alunos na UC de Laboratório de Informática, focando na manipulação de arquivos e repositórios usando o Doxygen. A estrutura do repositório no GitHub e a documentação gerada são detalhadas, incluindo comandos utilizados como git clone, git add, git commit e git push. O projeto resultou em um melhor entendimento sobre repositórios, documentação em LaTeX e programação em Linux.
Direitos autorais
© All Rights Reserved
Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.
Formatos disponíveis
Baixe no formato PDF, TXT ou leia on-line no Scribd
0% acharam este documento útil (0 voto)
5 visualizações23 páginas

Relatório de Projeto em Engenharia Informática

O relatório documenta o trabalho realizado por um grupo de alunos na UC de Laboratório de Informática, focando na manipulação de arquivos e repositórios usando o Doxygen. A estrutura do repositório no GitHub e a documentação gerada são detalhadas, incluindo comandos utilizados como git clone, git add, git commit e git push. O projeto resultou em um melhor entendimento sobre repositórios, documentação em LaTeX e programação em Linux.
Direitos autorais
© All Rights Reserved
Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.
Formatos disponíveis
Baixe no formato PDF, TXT ou leia on-line no Scribd

INSTITUTO POLITÉCNICO DO CÁVADO E AVE

ESCOLA SUPERIOR DE TECNOLOGIA

L ICENCIATURA EM E NGENHARIA DE S ISTEMAS


I NFORMÁTICOS
L ABORATÓRIO DE I NFORMÁTICA
2024/2025

Relatório do Projeto

Aluno: Docente:
Tiago Tavares - 26435 Óscar Ribeiro
Maria Machado - 26438
Henrique Gomes - 26427
Bernardo Martins - 25436

5 de janeiro de 2025
iii

Conteúdo

Lista de Figuras v

1 INTRODUÇÃO 1

2 Repositório Github 3
2.1 Estrutura do Repositório . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.2 Exemplo de Uso do Repositório . . . . . . . . . . . . . . . . . . . . . . 4

3 Estrutura da Documentação 7
3.1 Estrutura . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.2 Pasta src . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.3 Pasta doxdoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

4 Conclusões 15

5 Webgrafia e Ferramentas Utilizadas 17


5.1 Documentação de Doxygen . . . . . . . . . . . . . . . . . . . . . . . . 17
5.2 Ferramentas Utilizadas: . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
v

Lista de Figuras

2.1 Branches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.2 Git Clone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.3 Git Add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.4 Git Commit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.5 Git Push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.6 Criar Pull Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.7 Compare Pull Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.8 Merge Pull Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

3.1 Raíz da Documentação . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7


3.2 Doxyfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.3 README . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
3.4 Pasta src . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.5 Makefile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.6 Ementas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.7 Escolhas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.8 Funcionários . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.9 Main.c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.10 Pasta Doxdoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.11 Pasta html . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.12 Pasta latex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.13 Pdf Gerado . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1

Capítulo 1

INTRODUÇÃO

Este relatório tem como objetivo documentar todo o trabalho realizado pelo grupo
no projeto proposto no âmbito da UC de Laboratório de Informática.
Tanto a estrutura do código como as funcionalidades do mesmo estão documenta-
das no relatório gerado pela ferramenta Doxygen.
Neste relatório vamos focar na documentação do que foi pedido nesta unidade cur-
ricular, manipulação de ficheiros e repositórios e criação de relatórios com a ferra-
menta Doxygen.
3

Capítulo 2

Repositório Github

As tarefas foram igualmente divididas pelo grupo, depois de cada tarefa realizada
foi criada uma branch associada ao main do repositório.

2.1 Estrutura do Repositório


Na última atualização do repositório ficamos com 8 branches associadas ao main.

F IGURA 2.1: Branches


4 Capítulo 2. Repositório Github

2.2 Exemplo de Uso do Repositório


Depois de instalados as extensões e ferramentas necessárias para podermos realizar
a tarefa a que ficamos associados, o objetivo é passar para o repositório.
Fizemos git clone para fazermos uma cópia do repositório para um diretório local.

F IGURA 2.2: Git Clone

Usamos o comando git add para inserir os ficheiros no repositório.

F IGURA 2.3: Git Add

O comando git commit rastreia todos os ficheiros indicados.

F IGURA 2.4: Git Commit


2.2. Exemplo de Uso do Repositório 5

Usamos o comando git push para enviar os commits locais para o repositório
criado. Também usamos o git pull noutros casos para ir buscar o conteúdo do repo-
sitório.

F IGURA 2.5: Git Push


6 Capítulo 2. Repositório Github

Criamos o pull request. Agora no Github vamos comparar o conteúdo do pull


request com o do repositório. Por fim fazemos merge ao pull request.

F IGURA 2.6: Criar Pull Request

F IGURA 2.7: Compare Pull Request

F IGURA 2.8: Merge Pull Request


7

Capítulo 3

Estrutura da Documentação

3.1 Estrutura

F IGURA 3.1: Raíz da Documentação

Usamos o comando doxygen doxyfile. Ficheiro Doxyfile com as configurações


para gerar o relatório em latex com o doxygen.

F IGURA 3.2: Doxyfile


8 Capítulo 3. Estrutura da Documentação

Ficheiro README com as notas das versões do projeto.

F IGURA 3.3: README


3.2. Pasta src 9

3.2 Pasta src

F IGURA 3.4: Pasta src

Ficheiro Makefile.

F IGURA 3.5: Makefile


10 Capítulo 3. Estrutura da Documentação

Ficheiro de texto das ementas.

F IGURA 3.6: Ementas

Ficheiro de texto de escolhas.

F IGURA 3.7: Escolhas


3.2. Pasta src 11

Ficheiro de texto com a lista de funcionários.

F IGURA 3.8: Funcionários

Ficheiro main.c com a lógica e as funcionalidades do código.

F IGURA 3.9: Main.c


12 Capítulo 3. Estrutura da Documentação

3.3 Pasta doxdoc

F IGURA 3.10: Pasta Doxdoc

Pasta html.

F IGURA 3.11: Pasta html

Pasta latex.

F IGURA 3.12: Pasta latex


3.3. Pasta doxdoc 13

Com o comando Doxygen e o pdflatex [Link] criamos o pdf. Ficheiro de


relatório pdf gerado pelo doxygen em latex.

F IGURA 3.13: Pdf Gerado


15

Capítulo 4

Conclusões

Aprendemos a usar o sistema de repositórios Github e melhoramos os nossos conhe-


cimentos sobre máquinas virtuais, documentação em latex, programação em Linux
e manipulação de ficheiros.
17

Capítulo 5

Webgrafia e Ferramentas Utilizadas

5.1 Documentação de Doxygen


[Link]
[Link]
[Link]

5.2 Ferramentas Utilizadas:


[Link]
[Link]
[Link]
[Link]
[Link]

Você também pode gostar