Improvements in the documentation of `introprog.IO`. #14

lunduniversity / introprog-scalalib

Scala library with simple-to-use utilites for students of introductory programming. http://cs.lth.se/pgk/api

BSD 2-Clause "Simplified" License

60 stars 14 forks source link

Closed wudse20 closed 3 years ago

wudse20 commented 3 years ago

Added @param for each method to explain the parameters in better detail.
Added @return for each method, not the ones returning unit, to better explain the returnvalue of the methods.

wudse20 commented 3 years ago

I think this's better than it was before. I'd love some feedback on the pr.

bjornregnell commented 3 years ago

Thanks for working on this! Indeed more useful docs.