Add doc comments to recipes file

Author: Bryan Berg

ADNRecipes.php

@@ -1,4 +1,11 @@
 <?php
+/**
+ * ADNRecipes.php
+ * App.net PHP library
+ * https://github.com/jdolitsky/AppDotNetPHP
+ *
+ * This class contains some simple recipes for publishing to App.net.
+ */
 
 require_once "AppDotNet.php";
 
@@ -39,6 +46,11 @@ class ADNBroadcastMessageBuilder extends ADNRecipe {
     // stores the attachment filename
     private $_attachment = null;
 
+    /**
+     * Sets the destination channel ID. Required.
+     * @param string $channel_id The App.net Channel ID to send to. Get this
+     * from the web publisher tools if you don't have one.
+     */
     public function setChannelID($channel_id) {
         $this->_channel_id = $channel_id;
 
@@ -49,6 +61,12 @@ public function getChannelID() {
         return $this->_channel_id;
     }
 
+    /**
+     * Sets the broadcast headline. This string shows up in the push
+     * notifications which are sent to mobile apps, and is the title
+     * displayed in the UI.
+     * @param string $headline A short string for a headline.
+     */
     public function setHeadline($headline) {
         $this->_headline = $headline;
 
@@ -59,6 +77,12 @@ public function getHeadline() {
         return $this->_headline;
     }
 
+    /**
+     * Sets the broadcast text. This string shows up as a description
+     * on the broadcast detail page and in the "card" view in the
+     * mobile apps. Can contain links.
+     * @param string $text Broadcast body text.
+     */
     public function setText($text) {
         $this->_text = $text;
 
@@ -69,6 +93,12 @@ public function getText() {
         return $this->_text;
     }
 
+    /**
+     * Sets a flag which allows links to be parsed out of body text in
+     * [Markdown](http://daringfireball.net/projects/markdown/)
+     * format.
+     * @param bool $parseMarkdownLinks Parse markdown links.
+     */
     public function setParseMarkdownLinks($parseMarkdownLinks) {
         $this->_parseMarkdownLinks = $parseMarkdownLinks;
 
@@ -79,6 +109,10 @@ public function getParseMarkdownLinks() {
         return $this->_parseMarkdownLinks;
     }
 
+    /**
+     * Sets a flag which causes bare URLs in body text to be linkified.
+     * @param bool $parseLinks Parse links.
+     */
     public function setParseLinks($parseLinks) {
         $this->_parseLinks = $parseLinks;
 
@@ -89,6 +123,10 @@ public function getParseLinks() {
         return $this->_parseLinks;
     }
 
+    /**
+     * Sets the URL the broadcast should link to.
+     * @param string $readMoreLink Read more link URL.
+     */
     public function setReadMoreLink($readMoreLink) {
         $this->_readMoreLink = $readMoreLink;
 
@@ -99,6 +137,12 @@ public function getReadMoreLink() {
         return $this->_readMoreLink;
     }
 
+    /**
+     * Sets the filename of a photo associated with a broadcast.
+     * Probably requires the php-imagick extension. File will be
+     * uploaded to App.net.
+     * @param string $photo Photo filename.
+     */
     public function setPhoto($photo) {
         $this->_photo = $photo;
 
@@ -109,6 +153,11 @@ public function getPhoto() {
         return $this->_photo;
     }
 
+    /**
+     * Sets the filename of a attachment associated with a broadcast.
+     * File will be uploaded to App.net.
+     * @param string $attachment Attachment filename.
+     */
     public function setAttachment($attachment) {
         $this->_attachment = $attachment;
 
@@ -119,6 +168,9 @@ public function getAttachment() {
         return $this->_attachment;
     }
 
+    /**
+     * Sends the built-up broadcast.
+     */
     public function send() {
         $parseLinks = $this->_parseLinks || $this->_parseMarkdownLinks;
         $message = array(