Termux
/
termux-app
mirror of https://github.com/termux/termux-app
1
0
Fork 0
Code Issues Releases Wiki Activity

Changed: Minor refactor and comment updates of ReportActivity and ReportInfo

This commit is contained in:
agnostic-apollo 2021-09-11 13:48:30 +05:00
parent 783a840e3a
commit 0b47b20a9c
2 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
termux-shared/src/main/java/com/termux/shared/activities/ReportActivity.java
View File

@ -35,7 +35,7 @@ import io.noties.markwon.recycler.MarkwonAdapter;
import io.noties.markwon.recycler.SimpleEntry;
/**
* An activity to show reports in markdown format as per CommonMark spec.
* An activity to show reports in markdown format as per CommonMark spec based on config passed as {@link ReportInfo}.
* Add Following to `AndroidManifest.xml` to use in an app:
* {@code `<activity android:name="com.termux.shared.activities.ReportActivity" android:theme="@style/Theme.AppCompat.TermuxReportActivity" android:documentLaunchMode="intoExisting" />` }
* and
@ -60,10 +60,10 @@ public class ReportActivity extends AppCompatActivity {
public static final int ACTIVITY_TEXT_SIZE_LIMIT_IN_BYTES = 1000 * 1024; // 1MB
ReportInfo mReportInfo;
String mReportInfoFilePath;
String mReportActivityMarkdownString;
Bundle mBundle;
private ReportInfo mReportInfo;
private String mReportInfoFilePath;
private String mReportActivityMarkdownString;
private Bundle mBundle;
private static final String LOG_TAG = "ReportActivity";
@ -111,7 +111,7 @@ public class ReportActivity extends AppCompatActivity {
}
mReportInfo = null;
mReportInfoFilePath =null;
mReportInfoFilePath = null;
if (mBundle.containsKey(EXTRA_REPORT_INFO_OBJECT_FILE_PATH)) {
mReportInfoFilePath = mBundle.getString(EXTRA_REPORT_INFO_OBJECT_FILE_PATH);
@ -300,7 +300,7 @@ public class ReportActivity extends AppCompatActivity {
* Start the {@link ReportActivity}.
*
* @param context The {@link Context} for operations.
* @param reportInfo The {@link ReportInfo} contain info that needs to be displayed.
* @param reportInfo The {@link ReportInfo} containing info that needs to be displayed.
*/
public static void startReportActivity(@NonNull final Context context, @NonNull ReportInfo reportInfo) {
NewInstanceResult result = newInstance(context, reportInfo);
@ -321,7 +321,7 @@ public class ReportActivity extends AppCompatActivity {
* incrementally or at app startup.
*
* @param context The {@link Context} for operations.
* @param reportInfo The {@link ReportInfo} contain info that needs to be displayed.
* @param reportInfo The {@link ReportInfo} containing info that needs to be displayed.
* @return Returns {@link NewInstanceResult}.
*/
@NonNull

3
termux-shared/src/main/java/com/termux/shared/models/ReportInfo.java
View File

@ -5,6 +5,9 @@ import com.termux.shared.termux.AndroidUtils;
import java.io.Serializable;
/**
* An object that stored info for {@link com.termux.shared.activities.ReportActivity}.
*/
public class ReportInfo implements Serializable {
/** The user action that was being processed for which the report was generated. */