Updates to the code documentation (#38)

Author: idwilliams-2

src/main/java/com/microsoft/store/partnercenter/entitlements/EntitlementCollectionOperations.java

@@ -58,7 +58,6 @@ public IEntireEntityCollectionRetrievalOperations<Entitlement, ResourceCollectio
     /**
      * Gets the entitlements for a customer.
      * 
-     * @param  A flag to indicate if the expiry date is required to be returned along with the entitlement (if applicable).
      * @return The collection of entitlements for the customer.
      */
 	@Override

src/main/java/com/microsoft/store/partnercenter/invoices/EstimateCollectionOperations.java

@@ -28,6 +28,8 @@ public EstimateCollectionOperations(IPartner rootPartnerOperations)
 
     /**
      * Gets the estimate links of the recon line items.
+     * 
+     * @return The estimate links of the recon line items.
      */
     @Override
     public IEstimateLink getLinks() 

src/main/java/com/microsoft/store/partnercenter/invoices/IEstimateCollection.java

@@ -16,7 +16,9 @@ public interface IEstimateCollection
     extends IPartnerComponent<String>
 {
     /**
-     * Gets the estimate links of the recon line items.
+     * Gets the estimate links for the recon line items.
+     * 
+     * @return The estimate links for the recon line items.
      */
     IEstimateLink getLinks();
 }

src/main/java/com/microsoft/store/partnercenter/invoices/IInvoice.java

@@ -38,7 +38,8 @@ public interface IInvoice
      * 
      * @param billingProvider The billing provider.
      * @param invoiceLineItemType The invoice line item type.
-     * @return The invoice line item collection operations.
+     * 
+     * @return The available invoice line item collection operations given a billing provider and invoice line item type.
      */
     IInvoiceLineItemCollection by(BillingProvider billingProvider, InvoiceLineItemType invoiceLineItemType);
 
@@ -49,6 +50,8 @@ public interface IInvoice
      * @param invoiceLineItemType The type of invoice line item type.
      * @param currencyCode The currency code.
      * @param period The period for unbilled recon.
+     * 
+     * @return The available invoice line item collection operations given a billing provider and invoice line item type.
      */
     IReconLineItemCollection By(BillingProvider provider, InvoiceLineItemType invoiceLineItemType, String currencyCode, BillingPeriod period);
 
@@ -60,6 +63,8 @@ public interface IInvoice
      * @param currencyCode The currency code.
      * @param period The period for unbilled recon.
      * @param pageSize The number of records returned in a single operation.
+     * 
+     * @return The available invoice line item collection operations given a billing provider and invoice line item type.
      */
     IReconLineItemCollection By(BillingProvider provider, InvoiceLineItemType invoiceLineItemType, String currencyCode, BillingPeriod period, int pageSize);
 }

src/main/java/com/microsoft/store/partnercenter/invoices/InvoiceOperations.java

@@ -79,7 +79,6 @@ public IInvoiceLineItemCollection by( BillingProvider billingProvider, InvoiceLi
      * @param invoiceLineItemType The type of invoice line item type.
      * @param currencyCode The currency code.
      * @param period The period for unbilled recon.
-     * @param pageSize The number of records returned in a single operation.
      */
 	public IReconLineItemCollection By(BillingProvider provider, InvoiceLineItemType invoiceLineItemType, String currencyCode, BillingPeriod period)
 	{

src/main/java/com/microsoft/store/partnercenter/invoices/ReceiptCollectionOperations.java

@@ -19,7 +19,6 @@ public class ReceiptCollectionOperations
 	 * 
 	 * @param rootPartnerOperations The root partner operations instance.
 	 * @param invoiceId The invoice identifier.
-     * @param receiptId
 	 */
 	public ReceiptCollectionOperations(IPartner rootPartnerOperations, String invoiceId)
 	{

src/main/java/com/microsoft/store/partnercenter/invoices/ReceiptStatementOperations.java

@@ -25,7 +25,7 @@ public class ReceiptStatementOperations
 	 * 
 	 * @param rootPartnerOperations The root partner operations instance.
 	 * @param invoiceId The invoice identifier.
-     * @param receiptId
+     * @param receiptId The receipt identifier. 
 	 */
 	public ReceiptStatementOperations(IPartner rootPartnerOperations, String invoiceId, String receiptId)
 	{

src/main/java/com/microsoft/store/partnercenter/models/entitlements/Entitlement.java

@@ -105,6 +105,8 @@ public void setExpiryDate(DateTime value)
 
 	/**
 	 * Gets the fulfillment state for the entitlement.
+	 * 
+	 * @return The fulfillment state for the entitlement.
 	 */
 	public String getFulfillmentState()
 	{

src/main/java/com/microsoft/store/partnercenter/models/orders/OrderLinks.java

@@ -39,7 +39,6 @@ public Link getPatchOperation()
      * Sets the link to the patch operation of an order.
      * 
      * @param value The link to the patch operation of an order.
-     * @return The link to the patch operation of an order.
      */
     public void setPatchOperation(Link value)
     {
@@ -60,7 +59,6 @@ public Link getProvisioningStatus()
      * Sets the link to the provisioning status of an order.
      * 
      * @param value The link to the provisioning status of an order.
-     * @return The link to the provisioning status of an order.
      */
     public void setProvisioningStatus(Link value)
     {

src/main/java/com/microsoft/store/partnercenter/orders/IOrderLineItem.java

@@ -17,6 +17,8 @@ public interface IOrderLineItem
 {
     /**
      * Gets the available customer order line item activation link operations.
+     * 
+     * @return The available customer order line item activation link operations.
      */
     IOrderLineItemActivationLink getActivationLink();
 }