* Added some Javadoc to fix the checkstyle issues
authorJean-Manuel Da Silva <dasilvj at gmail dot com>
Sun, 28 Feb 2010 19:49:13 +0100
changeset 691 c775b32927ed
parent 690 c30c1fb78638
child 692 06bd95634e82
* Added some Javadoc to fix the checkstyle issues
.classpath
default.properties
src/com/beem/project/beem/package-info.java
src/com/beem/project/beem/provider/package-info.java
src/com/beem/project/beem/ui/Chat.java
src/com/beem/project/beem/ui/ContactList.java
src/com/beem/project/beem/ui/dialogs/builders/CreatePrivacyList.java
src/com/beem/project/beem/ui/dialogs/builders/DeleteContact.java
src/com/beem/project/beem/ui/dialogs/builders/DeletePrivacyList.java
src/com/beem/project/beem/ui/dialogs/builders/ResendSubscription.java
tools/checkstyle.xml
--- a/.classpath	Sun Feb 28 19:47:50 2010 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<classpath>
-	<classpathentry kind="src" path="src"/>
-	<classpathentry kind="src" path="gen"/>
-	<classpathentry kind="con" path="com.android.ide.eclipse.adt.ANDROID_FRAMEWORK"/>
-	<classpathentry kind="lib" path="libs/asmack-jse.jar"/>
-	<classpathentry kind="output" path="bin"/>
-</classpath>
--- a/default.properties	Sun Feb 28 19:47:50 2010 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,14 +0,0 @@
-# This file is automatically generated by Android Tools.
-# Do not modify this file -- YOUR CHANGES WILL BE ERASED!
-# 
-# This file must be checked in Version Control Systems.
-# 
-# To customize properties used by the Ant build system use,
-# "build.properties", and override values to adapt the script to your
-# project structure.
-
-# Indicates whether an apk should be generated for each density.
-split.density=false
-# Project target.
-target=android-7
-apk-configurations=
--- a/src/com/beem/project/beem/package-info.java	Sun Feb 28 19:47:50 2010 +0100
+++ b/src/com/beem/project/beem/package-info.java	Sun Feb 28 19:49:13 2010 +0100
@@ -41,5 +41,9 @@
     Head of the EIP Laboratory.
 
 */
+
+/**
+ * This package contains BEEM's entry points.
+ */
 package com.beem.project.beem;
 
--- a/src/com/beem/project/beem/provider/package-info.java	Sun Feb 28 19:47:50 2010 +0100
+++ b/src/com/beem/project/beem/provider/package-info.java	Sun Feb 28 19:49:13 2010 +0100
@@ -41,5 +41,9 @@
     Head of the EIP Laboratory.
 
 */
+
+/**
+ * This package contains classes concerning hypothetical providers.
+ */
 package com.beem.project.beem.provider;
 
--- a/src/com/beem/project/beem/ui/Chat.java	Sun Feb 28 19:47:50 2010 +0100
+++ b/src/com/beem/project/beem/ui/Chat.java	Sun Feb 28 19:49:13 2010 +0100
@@ -402,7 +402,8 @@
 	/**
 	 * Constructor.
 	 */
-	public BeemServiceConnection() { }
+	public BeemServiceConnection() {
+	}
 
 	/**
 	 * {@inheritDoc}.
@@ -411,9 +412,11 @@
 	public void onServiceConnected(ComponentName name, IBinder service) {
 	    mXmppFacade = IXmppFacade.Stub.asInterface(service);
 	    try {
-		if ((mRoster = mXmppFacade.getRoster()) != null)
+		mRoster = mXmppFacade.getRoster();
+		if (mRoster != null)
 		    mRoster.addRosterListener(mBeemRosterListener);
-		if ((mChatManager = mXmppFacade.getChatManager()) != null) {
+		mChatManager = mXmppFacade.getChatManager();
+		if (mChatManager != null) {
 		    mChatManager.addChatCreationListener(mChatManagerListener);
 		    changeCurrentChat(mContact);
 		}
--- a/src/com/beem/project/beem/ui/ContactList.java	Sun Feb 28 19:47:50 2010 +0100
+++ b/src/com/beem/project/beem/ui/ContactList.java	Sun Feb 28 19:49:13 2010 +0100
@@ -389,7 +389,7 @@
 	ViewStub stub = (ViewStub) findViewById(R.id.contactlist_stub);
 	if (stub != null)
 	    stub.inflate();
-	else 
+	else
 	    ((LinearLayout) findViewById(R.id.contactlist_groupstub)).setVisibility(View.VISIBLE);
 	Gallery g = (Gallery) findViewById(R.id.contactlist_banner);
 	g.setOnItemClickListener(new OnItemClickGroupName());
@@ -828,6 +828,9 @@
 	Log.e(TAG, "FINALIZE");
     }
 
+    /**
+     * Hide the groups view.
+     */
     private void hideGroups() {
 	ViewStub stub = (ViewStub) findViewById(R.id.contactlist_stub);
 	if (stub == null)
--- a/src/com/beem/project/beem/ui/dialogs/builders/CreatePrivacyList.java	Sun Feb 28 19:47:50 2010 +0100
+++ b/src/com/beem/project/beem/ui/dialogs/builders/CreatePrivacyList.java	Sun Feb 28 19:49:13 2010 +0100
@@ -73,24 +73,21 @@
     /**
      * Constructor.
      * @param context context activity.
+     * @param privacyListManager the privacy list manager that will be use to create our list.
      */
-    public CreatePrivacyList(final Context context,
-	final IPrivacyListManager privacyListManager) {
+    public CreatePrivacyList(final Context context, final IPrivacyListManager privacyListManager) {
 	super(context);
 
 	LayoutInflater factory = LayoutInflater.from(context);
 
-	mTextEntryView = factory.inflate(
-	    R.layout.privacy_list_create_dialog, null);
+	mTextEntryView = factory.inflate(R.layout.privacy_list_create_dialog, null);
 	setView(mTextEntryView);
 
 	mPrivacyListManager = privacyListManager;
-	mListNameField = (EditText) mTextEntryView.findViewById(
-	    R.id.privacy_list_create_dialog_list_name);
+	mListNameField = (EditText) mTextEntryView.findViewById(R.id.privacy_list_create_dialog_list_name);
 
 	setTitle(R.string.privacy_list_create_dialog_title);
-	setPositiveButton(R.string.privacy_list_create_dialog_create_button,
-	    new DialogClickListener());
+	setPositiveButton(R.string.privacy_list_create_dialog_create_button, new DialogClickListener());
 	setNegativeButton(R.string.CancelButton, new DialogClickListener());
     }
 
@@ -120,4 +117,4 @@
 	    }
 	}
     }
-}
\ No newline at end of file
+}
--- a/src/com/beem/project/beem/ui/dialogs/builders/DeleteContact.java	Sun Feb 28 19:47:50 2010 +0100
+++ b/src/com/beem/project/beem/ui/dialogs/builders/DeleteContact.java	Sun Feb 28 19:49:13 2010 +0100
@@ -53,9 +53,13 @@
 import com.beem.project.beem.service.Contact;
 import com.beem.project.beem.service.aidl.IRoster;
 
+/**
+ * Use this builder to build a dialog which allows you to delete a contact from a specific roster.
+ * @author Jean-Manuel Da Silva <dasilvj at beem-project dot com>
+ */
 public class DeleteContact extends AlertDialog.Builder {
 
-    private final static String TAG = "Dialogs.Builders > DeleteContact";
+    private static final String TAG = "Dialogs.Builders > DeleteContact";
 
     private IRoster mRoster;
     private Contact mContact;
@@ -63,9 +67,10 @@
     /**
      * Constructor.
      * @param context context activity.
+     * @param roster the roster which has the contact you want to delete.
+     * @param contact the contact to delete.
      */
-    public DeleteContact(final Context context, final IRoster roster,
-	final Contact contact) {
+    public DeleteContact(final Context context, final IRoster roster, final Contact contact) {
 	super(context);
 
 	mContact = contact;
--- a/src/com/beem/project/beem/ui/dialogs/builders/DeletePrivacyList.java	Sun Feb 28 19:47:50 2010 +0100
+++ b/src/com/beem/project/beem/ui/dialogs/builders/DeletePrivacyList.java	Sun Feb 28 19:49:13 2010 +0100
@@ -52,6 +52,10 @@
 import com.beem.project.beem.R;
 import com.beem.project.beem.service.aidl.IPrivacyListManager;
 
+/**
+ * Use this builder to build a dialog which allows you to delete a privacy list.
+ * @author Jean-Manuel Da Silva <dasilvj at beem-project dot com>
+ */
 public class DeletePrivacyList extends AlertDialog.Builder {
 
     private static final String TAG = "Dialogs.Builders > DeletePrivacyList";
@@ -62,16 +66,17 @@
     /**
      * Constructor.
      * @param context context activity.
+     * @param privacyListManager the privacy list manager managing the privacy list you want to delete.
+     * @param privacyListName the name of the privacy list you want to delete.
      */
-    public DeletePrivacyList(final Context context,
-	final IPrivacyListManager privacyListManager, final String privacyListName) {
+    public DeletePrivacyList(final Context context, final IPrivacyListManager privacyListManager,
+	final String privacyListName) {
 	super(context);
 
 	mPrivacyListManager = privacyListManager;
 	mPrivacyListName = privacyListName;
 
-	setMessage(context.getString(
-	    R.string.privacy_list_delete_dialog_msg, privacyListName));
+	setMessage(context.getString(R.string.privacy_list_delete_dialog_msg, privacyListName));
 	DialogClickListener dl = new DialogClickListener();
 	setPositiveButton(R.string.privacy_list_delete_dialog_yes, dl);
 	setNegativeButton(R.string.privacy_list_delete_dialog_no, dl);
--- a/src/com/beem/project/beem/ui/dialogs/builders/ResendSubscription.java	Sun Feb 28 19:47:50 2010 +0100
+++ b/src/com/beem/project/beem/ui/dialogs/builders/ResendSubscription.java	Sun Feb 28 19:49:13 2010 +0100
@@ -57,9 +57,13 @@
 import com.beem.project.beem.service.PresenceAdapter;
 import com.beem.project.beem.service.aidl.IXmppFacade;
 
+/**
+ * Use this builder to build a dialog which allows you resend a subscription query to a contact.
+ * @author Jean-Manuel Da Silva <dasilvj at beem-project dot com>
+ */
 public class ResendSubscription extends AlertDialog.Builder {
 
-    private final static String TAG = "Dialogs.Builders > ResendSubscription";
+    private static final String TAG = "Dialogs.Builders > ResendSubscription";
 
     private Context mContext;
     private IXmppFacade mXmppFacade;
@@ -67,10 +71,11 @@
 
     /**
      * Constructor.
-     * @param context context activity
+     * @param context context activity.
+     * @param xmppFacade the XMPP Facade used to send the query.
+     * @param contact the receiver of the query.
      */
-    public ResendSubscription(final Context context,
-	final IXmppFacade xmppFacade, final Contact contact) {
+    public ResendSubscription(final Context context, final IXmppFacade xmppFacade, final Contact contact) {
 	super(context);
 
 	mContext = context;
@@ -100,10 +105,8 @@
 		Presence presencePacket = new Presence(Presence.Type.subscribe);
 		presencePacket.setTo(mContact.getJID());
 		try {
-		    mXmppFacade.sendPresencePacket(
-			new PresenceAdapter(presencePacket));
-		    Toast.makeText(mContext, mContext.getString(
-			R.string.userinfo_resend), Toast.LENGTH_SHORT).show();
+		    mXmppFacade.sendPresencePacket(new PresenceAdapter(presencePacket));
+		    Toast.makeText(mContext, mContext.getString(R.string.userinfo_resend), Toast.LENGTH_SHORT).show();
 		} catch (RemoteException e) {
 		    Log.e(TAG, e.getMessage());
 		}
--- a/tools/checkstyle.xml	Sun Feb 28 19:47:50 2010 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,341 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE module PUBLIC
-    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
-    "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
-
-<!--
-
-  Checkstyle configuration that checks the sun coding conventions from:
-
-  - the Java Language Specification at
-  http://java.sun.com/docs/books/jls/second_edition/html/index.html
-
-  - the Sun Code Conventions at http://java.sun.com/docs/codeconv/
-
-  - the Javadoc guidelines at
-  http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
-
-  - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html
-
-  - some best practices
-
-  Checkstyle is very configurable. Be sure to read the documentation at
-  http://checkstyle.sf.net (or in your downloaded distribution).
-
-  Most Checks are configurable, be sure to consult the documentation.
-
-  To completely disable a check, just comment it out or delete it from the file.
-
-  Finally, it is worth reading the documentation.
-
--->
-
-<module name="Checker">
-  <!--
-        If you set the basedir property below, then all reported file
-        names will be relative to the specified directory. See
-        http://checkstyle.sourceforge.net/5.x/config.html#Checker
--->
-    <property name="basedir" value="/home/beem/"/>
-
-    <property name="severity" value="warning"/>
-
-    <!-- Checks that a package-info.java file exists for each package.     -->
-    <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
-    <module name="JavadocPackage">
-	<property name="allowLegacy" value="true"/>
-    </module>
-
-    <!-- Checks whether files end with a new line.                        -->
-    <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
-    <module name="NewlineAtEndOfFile">
-	<property name="severity" value="error"/>
-    </module>
-
-    <!-- Checks that property files contain the same keys.         -->
-    <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
-    <module name="Translation">
-	<property name="severity" value="error"/>
-    </module>
-
-    <!-- Checks for Size Violations.                    -->
-    <!-- See http://checkstyle.sf.net/config_sizes.html -->
-    <module name="FileLength"/>
-
-    <!-- Checks for whitespace                               -->
-    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
-    <!-- we want tab
-    <module name="FileTabCharacter"/>
-    -->
-
-    <!-- Miscellaneous other checks.                   -->
-    <!-- See http://checkstyle.sf.net/config_misc.html -->
-    <module name="RegexpSingleline">
-	<property name="severity" value="error"/>
-	<property name="format" value="\s+$"/>
-	<property name="minimum" value="0"/>
-	<property name="maximum" value="0"/>
-	<property name="message" value="Line has trailing spaces."/>
-    </module>
-
-    <!-- This rules is desactivated because it is too stupid.
-	It also compare the Header of the file.
-    <module name="StrictDuplicateCode">
-	<property name="min" value="25" />
-    </module>
-    -->
-
-    <!-- Header file -->
-    <module name="RegexpHeader">
-	<property name="headerFile" value="tools/JavaHeaderCheck.regex"/>
-	<property name="multiLines" value="5, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38"/>
-	<property name="severity" value="error" />
-    </module>
-
-    <module name="TreeWalker">
-
-	<!-- Checks for Javadoc comments.                     -->
-	<!-- See http://checkstyle.sf.net/config_javadoc.html -->
-	<module name="JavadocMethod">
-	    <property name="allowUndeclaredRTE" value="true"/>
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="JavadocType">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="JavadocVariable">
-	    <property name="scope" value="package" />
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="JavadocStyle">
-	    <property name="checkEmptyJavadoc" value="true"/>
-	    <property name="severity" value="error"/>
-	</module>
-
-
-	<!-- Checks for Naming Conventions.                  -->
-	<!-- See http://checkstyle.sf.net/config_naming.html -->
-	<module name="ConstantName"/>
-	<module name="LocalFinalVariableName"/>
-	<module name="LocalVariableName"/>
-	<module name="MemberName">
-	    <property  name="format" value="^m[A-Z][a-zA-Z0-9]*$"/>
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="MethodName"/>
-	<module name="PackageName"/>
-	<module name="ParameterName"/>
-	<module name="StaticVariableName"/>
-	<module name="TypeName"/>
-
-
-	<!-- Checks for Headers                                -->
-	<!-- See http://checkstyle.sf.net/config_header.html   -->
-	<!-- <module name="Header">                            -->
-	<!-- The follow property value demonstrates the ability     -->
-	<!-- to have access to ANT properties. In this case it uses -->
-	<!-- the ${basedir} property to allow Checkstyle to be run  -->
-	<!-- from any directory within a project. See property      -->
-	<!-- expansion,                                             -->
-	<!-- http://checkstyle.sf.net/config.html#properties        -->
-	<!-- <property                                              -->
-	<!--     name="headerFile"                                  -->
-	<!--     value="${basedir}/java.header"/>                   -->
-	<!-- </module> -->
-
-	<!-- Checks for imports                              -->
-	<!-- See http://checkstyle.sf.net/config_import.html -->
-	<module name="AvoidStarImport"/>
-	<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
-	<module name="RedundantImport"/>
-	<module name="UnusedImports">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="AvoidStaticImport">
-	    <property name="excludes" value="*"/>
-	</module>
-
-
-	<!-- Checks for Size Violations.                    -->
-	<!-- See http://checkstyle.sf.net/config_sizes.html -->
-	<module name="LineLength">
-	    <property name="max" value="120" />
-	</module>
-	<module name="MethodLength"/>
-	<module name="ParameterNumber"/>
-	<module name="AnonInnerLength">
-	    <property name="max" value="60" />
-	</module>
-
-
-	<!-- Checks for whitespace                               -->
-	<!-- See http://checkstyle.sf.net/config_whitespace.html -->
-	<module name="EmptyForIteratorPad"/>
-	<module name="GenericWhitespace">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="MethodParamPad">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="NoWhitespaceAfter">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="NoWhitespaceBefore">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="OperatorWrap"/>
-	<module name="ParenPad">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="TypecastParenPad">
-	    <property name="severity" value="error"/>
-	</module>
-	<!-- We want mixed tabulation
-	  <module name="TabCharacter"/> 
-	  -->
-	<module name="WhitespaceAfter">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="WhitespaceAround">
-	    <property name="severity" value="error"/>
-	</module>
-
-
-	<!-- Modifier Checks                                    -->
-	<!-- See http://checkstyle.sf.net/config_modifiers.html -->
-	<module name="ModifierOrder">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="RedundantModifier">
-	    <property name="severity" value="error"/>
-	</module>
-
-
-	<!-- Checks for blocks. You know, those {}'s         -->
-	<!-- See http://checkstyle.sf.net/config_blocks.html -->
-	<module name="AvoidNestedBlocks"/>
-	<module name="EmptyBlock"/>
-	<module name="LeftCurly">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="RightCurly">
-	    <property name="severity" value="error"/>
-	</module>
-	<!--
-	  <module name="NeedBraces"/>
-	  -->
-
-	<!-- Check for annotations 
-	http://checkstyle.sourceforge.net/config_annotation.html#MissingDeprecated
-	-->
-	<module name="AnnotationUseStyle">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="MissingDeprecated">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="MissingOverride">
-	    <property name="severity" value="error"/>
-	</module>
-
-	<!-- Checks for common coding problems               -->
-	<!-- See http://checkstyle.sf.net/config_coding.html -->
-	<module name="CovariantEquals"/>
-	<module name="AvoidInlineConditionals"/>
-	<module name="InnerAssignment" />
-	<module name="DoubleCheckedLocking"/>    <!-- MY FAVOURITE -->
-	<module name="EmptyStatement"/>
-	<module name="EqualsHashCode">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="HiddenField">
-	    <property name="ignoreConstructorParameter" value="true"/>
-	    <property name="ignoreAbstractMethods" value="true"/>
-	    <property name="ignoreSetter" value="true"/>
-	</module>
-	<module name="IllegalInstantiation"/>
-	<module name="InnerAssignment">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="MagicNumber"/>
-	<module name="MissingSwitchDefault">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="RedundantThrows"/>
-	<module name="SimplifyBooleanExpression">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="SimplifyBooleanReturn">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="StringLiteralEquality">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="IllegalCatch"/>
-	<module name="IllegalThrows"/>
-	<module name="IllegalType"/>
-	<module name="PackageDeclaration"/>
-	<module name="JUnitTestCase"/>
-	<module name="DeclarationOrder">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="ExplicitInitialization"/>
-	<module name="DefaultComesLast"/>
-	<module name="MissingCtor"/>
-	<module name="FallThrough"/>
-	<module name="MultipleStringLiterals">
-	    <property name="allowedDuplicates" value="2"/>
-	</module>
-	<module name="MultipleVariableDeclarations"/>
-	<module name="UnnecessaryParentheses"/>
-	<module name="ParameterAssignment"/>
-	<module name="EqualsAvoidNull">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="NoClone"/>
-	<module name="NoFinalizer"/>
-	<module name="SuperClone"/>
-	<module name="SuperFinalize"/>
-	<module name="ModifiedControlVariable">
-	    <property name="severity" value="error"/>
-	</module>
-	<module name="ReturnCount">
-	    <property name="max" value="3"/>
-	</module>
-
-	<!-- Checks for class design                         -->
-	<!-- See http://checkstyle.sf.net/config_design.html -->
-	<!-- 
-	  <module name="DesignForExtension"/>
-	  -->
-	<module name="FinalClass"/>
-	<module name="HideUtilityClassConstructor"/>
-	<!-- 
-	<module name="InterfaceIsType"/>
-	-->
-	<module name="VisibilityModifier"/>
-	<module name="MutableException"/>
-	<module name="ThrowsCount">
-	    <property name="max" value="2" />
-	</module>
-
-
-	<!-- Miscellaneous other checks.                   -->
-	<!-- See http://checkstyle.sf.net/config_misc.html -->
-	<module name="ArrayTypeStyle"/>
-	<module name="FinalParameters">
-	    <property name="tokens" value="CTOR_DEF"/>
-	</module>
-	<module name="Indentation"/>
-
-	<module name="TodoComment"/>
-	<module name="UpperEll"/>
-
-	<module name="BooleanExpressionComplexity"/>
-	<module name="UpperEll"/>
-
-	<module name="ArrayTypeStyle"/>
-
-    </module>
-
-</module>