Messaging: Fix javadoc

Change-Id: Ia1b0a8fa9a5e74078a68a55ca1953b6f085521b1
2024-12-26 15:54:37 +01:00
parent e29b158fba
commit 5403d02b5d
46 changed files with 20 additions and 170 deletions
@@ -94,8 +94,6 @@ import java.util.Set;
 * There are currently two main classes of notification and their rules: <p>
 * 1) Messages - {@link MessageNotificationState}. Only one message notification.
 * Unread messages across senders and conversations are coalesced.<p>
- * 2) Failed Messages - {@link MessageNotificationState#checkFailedMesages } Only one failed
- * message. Multiple failures are coalesced.<p>
 *
 * To add a new class of notifications, subclass the NotificationState and add commands which
 * create one and pass into general creation function.
@@ -90,7 +90,6 @@ public abstract class NotificationState {

    /**
     * Build the notification using the given builder.
-     * @param builder
     * @return The style of the notification.
     */
    protected abstract NotificationCompat.Style build(NotificationCompat.Builder builder);
@@ -434,8 +434,6 @@ public class SyncManager {
        /**
         * Load the recipients of a thread from telephony provider. If we fail, use
         * a predefined unknown recipient. This should not return null.
-         *
-         * @param threadId
         */
        public synchronized List<String> getThreadRecipients(final long threadId) {
            List<String> recipients = mThreadToRecipients.get(threadId);
@@ -69,9 +69,8 @@ public abstract class Action implements Parcelable {

    /**
     * Queues up background actions for background processing after the current action has
-     * completed its processing ({@link #executeAction}, {@link processBackgroundCompletion}
-     * or {@link #processBackgroundFailure}) on the Action thread.
-     * @param backgroundAction
+     * completed its processing ({@link #executeAction} or {@link #processBackgroundFailure})
+     * on the Action thread.
     */
    protected void requestBackgroundWork(final Action backgroundAction) {
        mBackgroundActions.add(backgroundAction);
@@ -81,7 +81,6 @@ public class ActionServiceImpl extends JobIntentService {

    /**
     * Handle response returned by BackgroundWorker
-     * @param request - request generating response
     * @param response - response from service
     */
    protected static void handleResponseFromBackgroundWorker(final Action action,
@@ -98,7 +97,6 @@ public class ActionServiceImpl extends JobIntentService {

    /**
     * Handle response returned by BackgroundWorker
-     * @param request - request generating failure
     */
    protected static void handleFailureFromBackgroundWorker(final Action action,
            final Exception exception) {
@@ -234,7 +234,6 @@ public class ProcessPendingMessagesAction extends Action implements Parcelable {
    /**
     * Queue any pending actions
     *
-     * @param actionState
     * @return true if action queued (or no actions to queue) else false
     */
    private boolean queueActions(final Action processingAction) {
@@ -124,8 +124,6 @@ class SyncMessageBatch {

    /**
     * Store the SMS message into local database.
-     *
-     * @param sms
     */
    private void storeSms(final DatabaseWrapper db, final SmsMessage sms) {
        if (sms.mBody == null) {
@@ -225,8 +223,6 @@ class SyncMessageBatch {

    /**
     * Store the MMS message into local database
-     *
-     * @param mms
     */
    private void storeMms(final DatabaseWrapper db, final MmsMessage mms) {
        if (mms.mParts.size() < 1) {
@@ -349,9 +345,6 @@ class SyncMessageBatch {
     * Batch delete database rows by matching a column with a list of values, usually some
     * kind of IDs.
     *
-     * @param table
-     * @param column
-     * @param ids
     * @return Total number of deleted messages
     */
    private static int batchDelete(final DatabaseWrapper db, final String table,
@@ -16,7 +16,7 @@
 */
 package com.android.messaging.datamodel.binding;

-/**
+/*
 * The binding class keeps track of a binding between a ui component and an item of BindableData
 * It allows each side to ensure that when it communicates with the other they are still bound
 * together.
@@ -202,7 +202,6 @@ public class ConversationMessageData {
     * ignoring the outer quotes and the divider and replacing any pair of consecutive
     * single quotes with a single single quote.
     *
-     * @param inputString
     * @return array of constituent strings
     */
    @VisibleForTesting
@@ -648,7 +648,6 @@ public class DraftMessageData extends BindableData implements ReadDraftDataActio

    /**
     * Check if Bugle is default sms app
-     * @return
     */
    public boolean getIsDefaultSmsApp() {
        return PhoneUtils.getDefault().isDefaultSmsApp();
@@ -92,7 +92,6 @@ public abstract class ImageRequest<D extends ImageRequestDescriptor>

    /**
     * Retrieves an input stream from which image resource could be loaded.
-     * @throws FileNotFoundException
     */
    protected abstract InputStream getInputStreamForResource() throws FileNotFoundException;

@@ -131,7 +131,6 @@ public class PoolableImageCache extends MediaCache<ImageResource> {
         * @param width The width of the bitmap.
         * @param height The height of the bitmap.
         * @return The decoded Bitmap with the resource drawn in it.
-         * @throws IOException
         */
        public Bitmap decodeSampledBitmapFromInputStream(@NonNull final InputStream inputStream,
                @NonNull final BitmapFactory.Options optionsTmp,
@@ -172,7 +171,6 @@ public class PoolableImageCache extends MediaCache<ImageResource> {
         * @param width The width of the bitmap.
         * @param height The height of the bitmap.
         * @return A Bitmap with the encoded bytes drawn in it.
-         * @throws IOException
         */
        public Bitmap decodeByteArray(@NonNull final byte[] bytes,
                @NonNull final BitmapFactory.Options optionsTmp, final int width,
@@ -54,7 +54,6 @@ public class UriImageRequestDescriptor extends ImageRequestDescriptor {
     * Creates a new Uri-based image request.
     * @param uri the content Uri. Currently Bugle only supports local resources Uri (i.e. it has
     * to begin with content: or android.resource:
-     * @param circleStrokeColor
     */
    public UriImageRequestDescriptor(final Uri uri, final int desiredWidth,
            final int desiredHeight, final int sourceWidth, final int sourceHeight,