Wikimedia

Commons Android app: Add documentation to 200 lines of Java code

What we consider "enough" documentation: Javadoc comment for every class, every member, every method (even if @Override).

Steps:

  1. Fork and clone https://github.com/commons-app/apps-android-commons
  2. Choose one or several Java file from https://github.com/commons-app/apps-android-commons/tree/master/app/src/main/java/fr/free/nrw/commons . In total, the number of lines must be over 200. For instance one file of 300 lines, or three files of 80 lines. They must be .java files and have not enough Javadoc documentation
  3. Add enough Javadoc comments. No class/member/method should be left without one. Be sure to understand very well what each thing does before writing its Javadoc, or choose another class if unsure.
  4. Send us a pull request

https://en.wikipedia.org/wiki/Javadoc#Overview_of_Javadoc Example of a recently accepted task: https://github.com/commons-app/apps-android-commons/pull/1011/files

Task tags

  • android
  • documentation
  • java
  • javadoc

Students who completed this task

Xiang Fan, Clay Tsay, Prajeen Govardhanam, Sanath

Task type

  • code Code
  • chrome_reader_mode Documentation / Training

Level

Beginner
close

2017