AILab-FOI / akdb

An experimental relational DBMS developed by students @ Faculty of Organization and Informatics, University of Zagreb
6 stars 23 forks source link

Unaprijeđenje dokumentacije i wiki #163

Closed mschatten closed 5 years ago

mschatten commented 5 years ago

Čišćenje dokumentacije u kodu:

U mnogim datotekama komentari koji se uvoze u Doxygen, ali i općenito opisuju kod su neispravni ili zastarjeli, npr.:

Theta_join.h sadrži komentare koda za implementaciju, a već su implementirani Potrebno je ispraviti dobar dio dokumentacije (komentara) unutar /rel/ direktorija (e.g. engleska gramatika). Komentari u .h datotekama govore da one sadrže strukture, no u većini slučaja sadrže samo metode bez ikakvih struktura.

itd.

Potrebno je sustavno proći kroz sve komentare i ispraviti ih gdje je to moguće, nadopuniti ako neki dio koda nije dokumentiran odnosno obrisati nepotrebne i zastarjele komentare.

JodaVz commented 5 years ago

javljam se za riješenje problema, posebice onih opisanih u mojoj prvoj zadaći

goranalkovic commented 5 years ago

Javljam se za rješavanje