mnalis/apps-android-commons
1
0
Fork 0
mirror of https://github.com/commons-app/apps-android-commons.git synced 2025-10-27 12:53:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added JavaDocs

Browse source 
Added JavaDocs to various files, namely License, Media, PageTitle, and Utils.
This commit is contained in:
Clay Tsay 2017-12-10 00:28:51 -08:00
parent f1edbfbedd
commit eeea0774b6
4 changed files with 120 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

18
app/src/main/java/fr/free/nrw/commons/License.java
View file

@ -8,6 +8,16 @@ public class License {
private String url;
private String name;
/**
* Constructs a new instance of License.
*
* @param key license key
* @param template license template
* @param url license URL
* @param name licence name
*
* @throws RuntimeException if License.key or Licence.template is null
*/
public License(String key, String template, String url, String name) {
if (key == null) {
throw new RuntimeException("License.key must not be null");
@ -21,10 +31,18 @@ public class License {
this.name = name;
}
/**
* Gets the license key.
* @return license key as a String.
*/
public String getKey() {
return key;
}
/**
* Gets the license template.
* @return license template as a String.
*/
public String getTemplate() {
return template;
}