Skip to content
Browse files

Add some simple javadocs to the interface

  • Loading branch information...
1 parent 81f11bc commit 8c73d8180a934b937b6e4d3e5e1b6344305c54d6 @mattr- mattr- committed
Showing with 21 additions and 0 deletions.
  1. +21 −0 simpenotelib/src/com/github/simplenotelib/SimpleNoteAPI.java
View
21 simpenotelib/src/com/github/simplenotelib/SimpleNoteAPI.java
@@ -4,12 +4,33 @@
public interface SimpleNoteAPI {
+ /**
+ * Login to the simple notes service
+ * @throws IOException
+ */
public abstract void login() throws IOException;
+ /**
+ * Get a note based on it's key as returned by the SimpleNotes service
+ * @param key the key to use when finding the note
+ * @return the note found by key
+ * @throws IOException
+ */
public abstract Note get(String key) throws IOException;
+ /**
+ * Sync a note to the SimpleNotes service
+ * @param note the note to sync
+ * @return The note that was synced, updated with the information added
+ * by the SimpleNotes service
+ * @throws IOException
+ */
public abstract Note add(Note note) throws IOException;
+ /**
+ * Get the username used for all transactions with the SimpleNote service
+ * @return the username used with the SimpleNote service
+ */
public abstract String getEmail();
}

0 comments on commit 8c73d81

Please sign in to comment.
Something went wrong with that request. Please try again.