From: Lennart Rosam Date: Wed, 16 May 2012 09:07:39 +0000 (+0200) Subject: Javadoc @param formatting fix X-Git-Tag: oc-android-1.4.3~417 X-Git-Url: http://git.linex4red.de/pub/Android/ownCloud.git/commitdiff_plain/ad8dbb31af7e8fcdc1281ba4f0091913b17adc6a?ds=inline;hp=--cc Javadoc @param formatting fix --- ad8dbb31af7e8fcdc1281ba4f0091913b17adc6a diff --git a/.settings/org.eclipse.jdt.core.prefs b/.settings/org.eclipse.jdt.core.prefs index d059138d..e1a30b9e 100644 --- a/.settings/org.eclipse.jdt.core.prefs +++ b/.settings/org.eclipse.jdt.core.prefs @@ -57,7 +57,7 @@ org.eclipse.jdt.core.formatter.comment.format_source_code=true org.eclipse.jdt.core.formatter.comment.indent_parameter_description=true org.eclipse.jdt.core.formatter.comment.indent_root_tags=true org.eclipse.jdt.core.formatter.comment.insert_new_line_before_root_tags=insert -org.eclipse.jdt.core.formatter.comment.insert_new_line_for_parameter=insert +org.eclipse.jdt.core.formatter.comment.insert_new_line_for_parameter=do not insert org.eclipse.jdt.core.formatter.comment.line_length=80 org.eclipse.jdt.core.formatter.comment.new_lines_at_block_boundaries=true org.eclipse.jdt.core.formatter.comment.new_lines_at_javadoc_boundaries=true diff --git a/.settings/org.eclipse.jdt.ui.prefs b/.settings/org.eclipse.jdt.ui.prefs index 9bbc5b23..59b47236 100644 --- a/.settings/org.eclipse.jdt.ui.prefs +++ b/.settings/org.eclipse.jdt.ui.prefs @@ -1,3 +1,3 @@ eclipse.preferences.version=1 -formatter_profile=_eclipse [spaces-only] +formatter_profile=_'eclipse [spaces-only]' formatter_settings_version=12 diff --git a/src/eu/alefzero/owncloud/AccountUtils.java b/src/eu/alefzero/owncloud/AccountUtils.java index de87660c..049a08cc 100644 --- a/src/eu/alefzero/owncloud/AccountUtils.java +++ b/src/eu/alefzero/owncloud/AccountUtils.java @@ -39,8 +39,7 @@ public class AccountUtils { * Can be used to get the currently selected ownCloud account in the * preferences * - * @param context - * The current appContext + * @param context The current appContext * @return The current account or first available, if none is available, * then null. */ @@ -78,8 +77,7 @@ public class AccountUtils { /** * - * @param version - * version of owncloud + * @param version version of owncloud * @return webdav path for given OC version, null if OC version unknown */ public static String getWebdavPath(OwnCloudVersion version) { diff --git a/src/eu/alefzero/owncloud/authenticator/EasySSLSocketFactory.java b/src/eu/alefzero/owncloud/authenticator/EasySSLSocketFactory.java index 3c2eac7a..c4531ba6 100644 --- a/src/eu/alefzero/owncloud/authenticator/EasySSLSocketFactory.java +++ b/src/eu/alefzero/owncloud/authenticator/EasySSLSocketFactory.java @@ -154,23 +154,17 @@ public class EasySSLSocketFactory implements ProtocolSocketFactory { * terminates and throws an {@link ConnectTimeoutException} *

* - * @param host - * the host name/IP - * @param port - * the port on the host - * @param clientHost - * the local host name/IP to bind the socket to - * @param clientPort - * the port on the local machine - * @param params - * {@link HttpConnectionParams Http connection parameters} + * @param host the host name/IP + * @param port the port on the host + * @param clientHost the local host name/IP to bind the socket to + * @param clientPort the port on the local machine + * @param params {@link HttpConnectionParams Http connection parameters} * * @return Socket a new socket * - * @throws IOException - * if an I/O error occurs while creating the socket - * @throws UnknownHostException - * if the IP address of the host cannot be determined + * @throws IOException if an I/O error occurs while creating the socket + * @throws UnknownHostException if the IP address of the host cannot be + * determined */ public Socket createSocket(final String host, final int port, final InetAddress localAddress, final int localPort, diff --git a/src/eu/alefzero/owncloud/datamodel/OCFile.java b/src/eu/alefzero/owncloud/datamodel/OCFile.java index 71c161a8..e2cebcfc 100644 --- a/src/eu/alefzero/owncloud/datamodel/OCFile.java +++ b/src/eu/alefzero/owncloud/datamodel/OCFile.java @@ -50,8 +50,7 @@ public class OCFile implements Parcelable { /** * Create new {@link OCFile} with given path * - * @param path - * The remote path of the file + * @param path The remote path of the file */ public OCFile(String path) { resetData(); @@ -62,8 +61,7 @@ public class OCFile implements Parcelable { /** * Reconstruct from parcel * - * @param source - * The source parcel + * @param source The source parcel */ private OCFile(Parcel source) { mId = source.readLong(); @@ -135,8 +133,7 @@ public class OCFile implements Parcelable { /** * Can be used to set the path where the file is stored * - * @param storage_path - * to set + * @param storage_path to set */ public void setStoragePath(String storage_path) { mLocalPath = storage_path; @@ -154,8 +151,7 @@ public class OCFile implements Parcelable { /** * Set a UNIX timestamp of the time the file was created * - * @param creation_timestamp - * to set + * @param creation_timestamp to set */ public void setCreationTimestamp(long creation_timestamp) { mCreationTimestamp = creation_timestamp; @@ -173,8 +169,7 @@ public class OCFile implements Parcelable { /** * Set a UNIX timestamp of the time the time the file was modified. * - * @param modification_timestamp - * to set + * @param modification_timestamp to set */ public void setModificationTimestamp(long modification_timestamp) { mModifiedTimestamp = modification_timestamp; @@ -206,10 +201,9 @@ public class OCFile implements Parcelable { * Adds a file to this directory. If this file is not a directory, an * exception gets thrown. * - * @param file - * to add - * @throws IllegalStateException - * if you try to add a something and this is not a directory + * @param file to add + * @throws IllegalStateException if you try to add a something and this is + * not a directory */ public void addFile(OCFile file) throws IllegalStateException { if (isDirectory()) { @@ -238,8 +232,7 @@ public class OCFile implements Parcelable { /** * Sets the ID of the file * - * @param file_id - * to set + * @param file_id to set */ public void setFileId(long file_id) { mId = file_id; @@ -248,8 +241,7 @@ public class OCFile implements Parcelable { /** * Sets the Mime-Type of the * - * @param mimetype - * to set + * @param mimetype to set */ public void setMimetype(String mimetype) { mMimeType = mimetype; @@ -258,8 +250,7 @@ public class OCFile implements Parcelable { /** * Sets the ID of the parent folder * - * @param parent_id - * to set + * @param parent_id to set */ public void setParentId(long parent_id) { mParentId = parent_id; @@ -268,8 +259,7 @@ public class OCFile implements Parcelable { /** * Sets the file size in bytes * - * @param file_len - * to set + * @param file_len to set */ public void setFileLength(long file_len) { mLength = file_len; diff --git a/src/eu/alefzero/owncloud/location/LocationServiceLauncherReciever.java b/src/eu/alefzero/owncloud/location/LocationServiceLauncherReciever.java index 9c210bb5..a435414b 100644 --- a/src/eu/alefzero/owncloud/location/LocationServiceLauncherReciever.java +++ b/src/eu/alefzero/owncloud/location/LocationServiceLauncherReciever.java @@ -52,8 +52,7 @@ public class LocationServiceLauncherReciever extends BroadcastReceiver { /** * Used internally. Starts or stops the device tracking service * - * @param trackDevice - * true to start the service, false to stop it + * @param trackDevice true to start the service, false to stop it */ private void startOrStopDeviceTracking(Context context, boolean trackDevice) { Intent deviceTrackingIntent = new Intent(); diff --git a/src/eu/alefzero/owncloud/ui/QuickAction.java b/src/eu/alefzero/owncloud/ui/QuickAction.java index fdd21d79..e1d97d22 100644 --- a/src/eu/alefzero/owncloud/ui/QuickAction.java +++ b/src/eu/alefzero/owncloud/ui/QuickAction.java @@ -65,8 +65,7 @@ public class QuickAction extends CustomPopup { /** * Constructor * - * @param anchor - * {@link View} on where the popup window should be displayed + * @param anchor {@link View} on where the popup window should be displayed */ public QuickAction(View anchor) { super(anchor); @@ -91,8 +90,7 @@ public class QuickAction extends CustomPopup { /** * Set animation style * - * @param animStyle - * animation style, default is set to ANIM_AUTO + * @param animStyle animation style, default is set to ANIM_AUTO */ public void setAnimStyle(int animStyle) { this.animStyle = animStyle; @@ -101,8 +99,7 @@ public class QuickAction extends CustomPopup { /** * Add action item * - * @param action - * {@link ActionItem} object + * @param action {@link ActionItem} object */ public void addActionItem(ActionItem action) { actionList.add(action); @@ -181,13 +178,10 @@ public class QuickAction extends CustomPopup { /** * Set animation style * - * @param screenWidth - * screen width - * @param requestedX - * distance from left edge - * @param onTop - * flag to indicate where the popup should be displayed. Set TRUE - * if displayed on top of anchor view and vice versa + * @param screenWidth screen width + * @param requestedX distance from left edge + * @param onTop flag to indicate where the popup should be displayed. Set + * TRUE if displayed on top of anchor view and vice versa */ private void setAnimationStyle(int screenWidth, int requestedX, boolean onTop) { @@ -257,12 +251,9 @@ public class QuickAction extends CustomPopup { /** * Get action item {@link View} * - * @param title - * action item title - * @param icon - * {@link Drawable} action item icon - * @param listener - * {@link View.OnClickListener} action item listener + * @param title action item title + * @param icon {@link Drawable} action item icon + * @param listener {@link View.OnClickListener} action item listener * @return action item {@link View} */ private View getActionItem(String title, Drawable icon, @@ -291,10 +282,8 @@ public class QuickAction extends CustomPopup { /** * Show arrow * - * @param whichArrow - * arrow type resource id - * @param requestedX - * distance from left screen + * @param whichArrow arrow type resource id + * @param requestedX distance from left screen */ private void showArrow(int whichArrow, int requestedX) { final View showArrow = (whichArrow == R.id.arrow_up) ? mArrowUp diff --git a/src/eu/alefzero/owncloud/ui/fragment/FileDetailFragment.java b/src/eu/alefzero/owncloud/ui/fragment/FileDetailFragment.java index 5dbb56eb..a01ce79e 100644 --- a/src/eu/alefzero/owncloud/ui/fragment/FileDetailFragment.java +++ b/src/eu/alefzero/owncloud/ui/fragment/FileDetailFragment.java @@ -73,8 +73,7 @@ public class FileDetailFragment extends SherlockFragment implements * to contain {@link FileDetailFragment#FILE} with an OCFile and also * {@link FileDownloader#EXTRA_ACCOUNT} with the account. * - * @param nonEmptyFragment - * True, to enable file detail rendering + * @param nonEmptyFragment True, to enable file detail rendering */ public FileDetailFragment(Intent intent) { mLayout = R.layout.file_details_fragment; @@ -101,9 +100,8 @@ public class FileDetailFragment extends SherlockFragment implements /** * Use this method to signal this Activity that it shall update its view. * - * @param intent - * The {@link Intent} that contains extra information about this - * file The intent needs to have these extras: + * @param intent The {@link Intent} that contains extra information about + * this file The intent needs to have these extras: *

* * {@link FileDetailFragment#FILE}: An {@link OCFile}