Added JavaDoc code samples

Author: puf

app/app.iml

@@ -86,6 +86,7 @@
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/rs" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/symbols" />
       <excludeFolder url="file://$MODULE_DIR$/build/outputs" />
+      <excludeFolder url="file://$MODULE_DIR$/build/tmp" />
     </content>
     <orderEntry type="jdk" jdkName="Android API 22 Platform" jdkType="Android SDK" />
     <orderEntry type="sourceFolder" forTests="false" />

library/src/main/java/com/firebase/ui/FirebaseListAdapter.java

@@ -43,6 +43,21 @@
  * instance of your list item mLayout and an instance your class that holds your data. Simply populate the view however
  * you like and this class will handle updating the list as the data changes.
  *
+ * <blockquote><pre>
+ * {@code
+ *     Firebase ref = new Firebase("https://<yourapp>.firebaseio.com");
+ *     ListAdapter adapter = new FirebaseListAdapter<ChatMessage>(this, ChatMessage.class, android.R.layout.two_line_list_item, mRef)
+ *     {
+ *         protected void populateView(View view, ChatMessage chatMessage)
+ *         {
+ *             ((TextView)view.findViewById(android.R.id.text1)).setText(chatMessage.getName());
+ *             ((TextView)view.findViewById(android.R.id.text2)).setText(chatMessage.getMessage());
+ *         }
+ *     };
+ *     listView.setListAdapter(adapter);
+ * }
+ * </pre></blockquote>
+ *
  * @param <T> The class type to use as a model for the data contained in the children of the given Firebase location
  */
 public abstract class FirebaseListAdapter<T> extends BaseAdapter {

library/src/main/java/com/firebase/ui/FirebaseRecyclerViewAdapter.java

@@ -47,6 +47,35 @@
  * To use this class in your app, subclass it passing in all required parameters and implement the
  * populateViewHolder method.
  *
+ * <blockquote><pre>
+ * {@code
+ * private static class ChatMessageViewHolder extends RecyclerView.ViewHolder {
+ *     TextView messageText;
+ *     TextView nameText;
+ *
+ *     public ChatMessageViewHolder(View itemView) {
+ *         super(itemView);
+ *         nameText = (TextView)itemView.findViewById(android.R.id.text1);
+ *         messageText = (TextView) itemView.findViewById(android.R.id.text2);
+ *     }
+ * }
+ *
+ * FirebaseRecyclerViewAdapter<ChatMessage, ChatMessageViewHolder> adapter;
+ * ref = new Firebase("https://<yourapp>.firebaseio.com");
+ *
+ * RecyclerView recycler = (RecyclerView) findViewById(R.id.messages_recycler);
+ * recycler.setHasFixedSize(true);
+ * recycler.setLayoutManager(new LinearLayoutManager(this));
+ *
+ * adapter = new FirebaseRecyclerViewAdapter<ChatMessage, ChatMessageViewHolder>(ChatMessage.class, android.R.layout.two_line_list_item, ChatMessageViewHolder.class, mRef) {
+ *     public void populateViewHolder(ChatMessageViewHolder chatMessageViewHolder, ChatMessage chatMessage) {
+ *         chatMessageViewHolder.nameText.setText(chatMessage.getName());
+ *         chatMessageViewHolder.messageText.setText(chatMessage.getMessage());
+ *     }
+ * };
+ * recycler.setAdapter(mAdapter);
+ *
+ *
  * @param <T> The Java class that maps to the type of objects stored in the Firebase location.
  * @param <VH> The ViewHolder class that contains the Views in the layout that is shown for each object.
  */