Karl/BobStore
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

convert App comments to javadoc so they can be read in popups, etc.

Browse Source 
Decent Java editors have all sorts of nice ways to show javadoc comments,
whether they are for public or private APIs.  So comments should be in that
format whenever possible.
This commit is contained in:
Hans-Christoph Steiner 2016-05-27 20:48:09 +02:00
parent 1410a720c8
commit f7688d7f9a
3 changed files with 49 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
app/src/main/java/org/fdroid/fdroid/data/Apk.java
View File

@ -32,19 +32,25 @@ public class Apk extends ValueObject implements Comparable<Apk> {
public Utils.CommaSeparatedList nativecode; // null if empty or unknown
// ID (md5 sum of public key) of signature. Might be null, in the
// transition to this field existing.
/**
* ID (md5 sum of public key) of signature. Might be null, in the
* transition to this field existing.
*/
public String sig;
// True if compatible with the device.
/**
* True if compatible with the device.
*/
public boolean compatible;
public String apkName; // F-Droid style APK name
public SanitizedFile installedFile; // the .apk file on this device's filesystem
// If not null, this is the name of the source tarball for the
// application. Null indicates that it's a developer's binary
// build - otherwise it's built from source.
/**
* If not null, this is the name of the source tarball for the
* application. Null indicates that it's a developer's binary
* build - otherwise it's built from source.
*/
public String srcname;
public int repoVersion;

48
app/src/main/java/org/fdroid/fdroid/data/App.java
View File

@ -37,7 +37,9 @@ public class App extends ValueObject implements Comparable<App> {
private static final String TAG = "App";
// True if compatible with the device (i.e. if at least one apk is)
/**
* True if compatible with the device (i.e. if at least one apk is)
*/
public boolean compatible;
public String packageName = "unknown";
@ -84,27 +86,39 @@ public class App extends ValueObject implements Comparable<App> {
public Date added;
public Date lastUpdated;
// List of categories (as defined in the metadata
// documentation) or null if there aren't any.
/**
* List of categories (as defined in the metadata documentation) or null if there aren't any.
*/
public Utils.CommaSeparatedList categories;
// List of anti-features (as defined in the metadata
// documentation) or null if there aren't any.
/**
* List of anti-features (as defined in the metadata documentation) or null if there aren't any.
*/
public Utils.CommaSeparatedList antiFeatures;
// List of special requirements (such as root privileges) or
// null if there aren't any.
/**
* List of special requirements (such as root privileges) or null if there aren't any.
*/
public Utils.CommaSeparatedList requirements;
// True if all updates for this app are to be ignored
/**
* True if all updates for this app are to be ignored
*/
public boolean ignoreAllUpdates;
// True if the current update for this app is to be ignored
/**
* True if the current update for this app is to be ignored
*/
public int ignoreThisUpdate;
// To be displayed at 48dp (x1.0)
/**
* To be displayed at 48dp (x1.0)
*/
public String iconUrl;
// To be displayed at 72dp (x1.5)
/**
* To be displayed at 72dp (x1.5)
*/
public String iconUrlLarge;
public String installedVersionName;
@ -476,16 +490,20 @@ public class App extends ValueObject implements Comparable<App> {
return updates;
}
// True if there are new versions (apks) available and the user wants
// to be notified about them
/**
* True if there are new versions (apks) available and the user wants
* to be notified about them
*/
public boolean canAndWantToUpdate() {
boolean canUpdate = hasUpdates();
boolean wantsUpdate = !ignoreAllUpdates && ignoreThisUpdate < suggestedVersionCode;
return canUpdate && wantsUpdate && !isFiltered();
}
// Whether the app is filtered or not based on AntiFeatures and root
// permission (set in the Settings page)
/**
* Whether the app is filtered or not based on AntiFeatures and root
* permission (set in the Settings page)
*/
public boolean isFiltered() {
return new AppFilter().filter(this);
}

6
app/src/main/java/org/fdroid/fdroid/data/Repo.java
View File

@ -121,8 +121,10 @@ public class Repo extends ValueObject {
return !TextUtils.isEmpty(this.signingCertificate);
}
// this happens when a repo is configed with a fingerprint, but the client
// has not connected to it yet to download its signing certificate
/**
* This happens when a repo is configed with a fingerprint, but the client
* has not connected to it yet to download its signing certificate
*/
public boolean isSignedButUnverified() {
return TextUtils.isEmpty(this.signingCertificate) && !TextUtils.isEmpty(this.fingerprint);
}