alessandro-bugatti / ask_mvc

Piccolo framework MVC di esempio
0 stars 2 forks source link

Add documentation #32

Closed alessandro-bugatti closed 4 years ago

alessandro-bugatti commented 4 years ago

Provate a dare un'occhiata, ho commentato tutto, per generare la documentazione automatica dovete usare Doxygen (in realtà anche altri strumenti che accettino la stessa sintassi o simile), io ho usato quello perchè l'avevo già installato sul computer, trovate un file Doxygen che è quello che deve essere usato per la generazione (se usate DoxyWizard basta caricarlo e fa tutto lui, vi trovate la documentazione nella cartella doc). L'ultimo che fa la revisione faccia pure il merge se non ci sono problemi, altrimenti li notifichi che li metto a posto. La parte della documentazione fatta da @GhostyJade è in inglese, io ho preferito farla in italiano perchè usandolo per la didattica viene più facile per gli studenti, al momento lasciamo pure così.

GhostyJade commented 4 years ago

Secondo me va bene...l'unica cosa è che provvederei ad uniformare la lingua della documentazione della mia classe in modo da non doverci tornare...me ne occupo io?

alessandro-bugatti commented 4 years ago

@GhostyJade aggiungi pure una commit a questa pull request, se avessi problemi di permessi fammi sapere