search

bcc-ufg-ed1 / FilaVet

Este repositório contém o projeto do TAD FilaVet, utilizado na disciplina de Estrutura de Dados 1 - Bacharelado em Ciência da Computação/Universidade Federal de Goiás/Jataí
0 stars 2 forks source link

Documentando as funções #1

Open pauloafpjunior opened 9 years ago

pauloafpjunior commented 9 years ago

Alterar o arquivo README, explicando quais funções estão disponíveis no TAD FilaVet, como elas devem ser utilizadas e o que elas fazem. Além disso, seria interessante apresentar um exemplo de uso desta função. Veja um exemplo de boa documentação em: http://www.cplusplus.com/reference/cstdio/printf/. Há uma ferramenta que gera documentação automaticamente, denominada Doxygen: http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html.

MarceloGouveia77 commented 9 years ago

Eu fui fazer a documentação no Doxygen, mas gerou uns arquivos html, quando abri no navegador apareceu umas coisas do código, meio que uma home com as funções, mas como colocar no readme ? teste

pauloafpjunior commented 9 years ago

Oi Marcelo. Legal, pode mandar os arquivos HTML para meu email, eu posto em uma conta no OpenShift e crio um link no README.md.