answered
2015-05-17 10:11:56 +0100
Nevím, co přesně myslíš termínem "plnotučný", ale fungující být musí, ta implementace musí dělat přesně to, co popisuje dokumentace. Program naopak může být velmi odtučněný, a může dělat nějaké nesmysly, třeba mít metody na vypisování AAA a BBB.
Důvod:
Pokud implementace nic nedělá, odevzdávají studenti dokumentační komentáře typu:
Lorem ipsum
Kill the orges
Nebo nezměněné vykopírované examply z mých příkladů.
Jsem přesvědčen, že toto studenty dokumentovat (např API v tomto případě) nenaučí, a úkolem této úlohy/tohoto tématu není vás jen naučit syntax doxygenu/manpage, ale i smysl.
Co můžeš dělat:
Pokud ti to licence dovoluje, můžeš odevzdat cizí kód se svými komentáři. V souladu s licencí bys to ale měl většinou uvést a odevzdaných README, AUTHORS a podobných souborech.
Můžeš také ideálně zvolit nějkaý upstreamový projekt, který dokumentaci nemá, poslat jim třeba na Githubu Pull Request apod.
Použít něco z PA1.
Odokumentovat třeba úlohu na Graphviz z TEDů - pokud budou stačit počty metod, tříd, apod...
Vymyslet jiné řešení.
