lunduniversity / introprog

Teaching material for "Introduction to Programming using Scala" at Lund University, LTH. http://cs.lth.se/pgk/
140 stars 167 forks source link

Appendex E, Documentation E.2.2, guidelines nonexistent? #715

Closed JonatanKrakhede closed 1 year ago

JonatanKrakhede commented 1 year ago

In E.2.2 below the box with comments: "Dokumentationskommentaren slutar med */ rakt under asterisk-kolumnen. I figur ?? på sidan ?? visas exempel på dokumentationskommentarer. Annoteringen @param i början på en rad ger en speciell kommentar angående parametrar. Annotering- en @return i början av en rad ger en speciell kommentar angående vad som returneras vid metodanrop. Riktlinjer för hur du skriver dokumentationskommentarer:" And the guidelines are not there? Why? Should there be guidelines and if not, why does it say that there should?

bjornregnell commented 1 year ago

It's good practice to check existing issues (also closed) and search for similar issues. Anyway thanks for reporting. Closing this as already fixed as reported in #714.

JonatanKrakhede commented 1 year ago

Aight sowy