Permalink
Browse files

Third pass at javadocs

  • Loading branch information...
1 parent bbb9bdf commit 736927de9adaf0df6741a80c68d9cb045ed36651 Sam Karp committed Apr 26, 2011
@@ -29,13 +29,13 @@
/** The server root url. */
@InjectResource(R.string.url_server_root) String serverRootUrl;
- /** The app path. */
+ /** The path for the application server. */
@InjectResource(R.string.url_relative_app) String appPath;
- /** The memo messages json. */
+ /** The path for the Memo homepage. */
@InjectResource(R.string.url_message_list) String memoMessagesJson;
- /** The create memo message json. */
+ /** The path for the create memo page. */
@InjectResource(R.string.url_create_message) String createMemoMessageJson;
/** The context provider. */
@@ -10,12 +10,13 @@
// TODO: Auto-generated Javadoc
/**
- * The Interface DjangoMemoInterface.
+ * The Interface DjangoMemoInterface. This provides access to the
+ * methods that manipulate the memos from the server.
*/
public interface DjangoMemoInterface {
/**
- * Gets the memos.
+ * Gets the available memos.
*
* @return the memos
* @throws ClientProtocolException the client protocol exception
@@ -11,7 +11,9 @@
// TODO: Auto-generated Javadoc
/**
- * The Class DjangoMemoJsonConverterImplementation.
+ * The Class DjangoMemoJsonConverterImplementation. This class
+ * provides the methods that manipulate the data into and from
+ * the Json string
*/
public class DjangoMemoJsonConverterImplementation
implements DjangoMemoJsonConverterInterface {
@@ -6,28 +6,32 @@
// TODO: Auto-generated Javadoc
/**
- * The Interface DjangoMemoJsonConverterInterface.
+ * The Interface DjangoMemoJsonConverterInterface. This class provides
+ * access to the methods that manipulate the Json string
*/
public interface DjangoMemoJsonConverterInterface {
/**
- * Deserialize list.
+ * This method creates a Gson object that uses Gson
+ * standards to pull the data from the list
*
* @param jsonString the json string
* @return the list
*/
List<GeoCamMemoMessage> deserializeList(String jsonString);
/**
- * Deserialize.
+ * This method creates a Gson object that uses Gson standards
+ * to pull the data from a Json string
*
* @param jsonString the json string
* @return the geo cam memo message
*/
GeoCamMemoMessage deserialize(String jsonString);
/**
- * Serialize.
+ * This method serializes the passed in object and
+ * converts it to a Json string.
*
* @param message the message
* @return the string

0 comments on commit 736927d

Please sign in to comment.