javadoc corrections

library/src/main/java/org/mustangproject/CII/CIIToUBL.java

@@ -8,14 +8,14 @@ import java.io.File;
 import java.io.Serializable;
 
 /***
- * converts a CII XML file to a UBL XML file
+ * converts a Cross Industry Invoice XML file to a UBL XML file
  * thanks to Philip Helger for his library
 */
 public class CIIToUBL {
 	/***
 	 * performs the actual conversion
-	 * @param input
-	 * @param output
+	 * @param input the CII file to convert
+	 * @param output the UBL file to write to
 	 */
    public void convert(File input, File output) {
 	   ErrorList occurred=new ErrorList();

library/src/main/java/org/mustangproject/Item.java

@@ -52,7 +52,7 @@ public class Item implements IZUGFeRDExportableItem {
 
 	/***
 	 * BT 132 (issue https://github.com/ZUGFeRD/mustangproject/issues/247)
-	 * @return
+	 * @return the line ID of the order (BT132)
 	 */
 	@Override
 	public String getBuyerOrderReferencedDocumentLineID() {

library/src/main/java/org/mustangproject/TradeParty.java

@@ -229,7 +229,7 @@ public class TradeParty implements IZUGFeRDExportableTradeParty {
 	/**
 	 * (optional)
 	 *
-	 * @param debitDetail
+	 * @param debitDetail e.g. containing IBAN and mandate
 	 * @return fluent setter
 	 */
 	public TradeParty addDebitDetails(IZUGFeRDTradeSettlementDebit debitDetail) {

library/src/main/java/org/mustangproject/ZUGFeRD/IZUGFeRDExportableItem.java

@@ -55,7 +55,7 @@ public interface IZUGFeRDExportableItem extends IAbsoluteValueProvider{
 
 	/***
 	 * BT 132 (issue https://github.com/ZUGFeRD/mustangproject/issues/247)
-	 * @return
+	 * @return the line ID of the order (BT-132)
 	 */
 	default String getBuyerOrderReferencedDocumentLineID() {
 		return null;
@@ -100,7 +100,7 @@ public interface IZUGFeRDExportableItem extends IAbsoluteValueProvider{
 
 	/***
 	 * allows to specify multiple(!) referenced documents along with e.g. their typecodes
-	 * @return
+	 * @return the referenced documents
 	 */
 	default IReferencedDocument[] getReferencedDocuments() {
 		return null;
@@ -134,9 +134,9 @@ public interface IZUGFeRDExportableItem extends IAbsoluteValueProvider{
 	}
 	
 	/***
-	 * specify allowances amount for the line item total, i.e. after item price is multiplied
-	 * by amount
-	 * @return
+	 * specify allowances amount for the line item total
+	 *
+	 * @return the sum of allowances for this item
 	 */
 	default IZUGFeRDAllowanceCharge[] getItemTotalAllowances() {
 		return null;

library/src/main/java/org/mustangproject/ZUGFeRD/XMPSchemaZugferd.java

@@ -83,6 +83,7 @@ public class XMPSchemaZugferd extends XMPSchema {
     /***
 	 * Specify a custom XMP metadata document type
 	 * @param type INVOICE or ORDER
+	 * @return fluent setter
 	 */
 	public XMPSchemaZugferd setType(String type) {
 		setTextPropertyValue("DocumentType", type);

library/src/main/java/org/mustangproject/ZUGFeRD/ZUGFeRD2PullProvider.java

@@ -114,10 +114,10 @@ public class ZUGFeRD2PullProvider implements IXMLProvider {
 	/***
 	 * returns the UN/CEFACT CII XML for companies(tradeparties), which is actually
 	 * the same for ZF1 (v 2013b) and ZF2 (v 2016b)
-	 * @param party
+	 * @param party any sender, recipient, seller or legal party involved
 	 * @param isSender some attributes are allowed only for senders in certain profiles
 	 * @param isShipToTradeParty some attributes are allowed only for senders or recipients
-	 * @return
+	 * @return CII XML
 	 */
 	protected String getTradePartyAsXML(IZUGFeRDExportableTradeParty party, boolean isSender, boolean isShipToTradeParty) {
 		String xml = "";
@@ -202,9 +202,9 @@ public class ZUGFeRD2PullProvider implements IXMLProvider {
 
 	/***
 	 * returns the XML for a charge or allowance on item level
-	 * @param allowance
-	 * @param item
-	 * @return
+	 * @param allowance the allowance or charge on this item
+	 * @param item the item
+	 * @return CII XML
 	 */
 	protected String getAllowanceChargeStr(IZUGFeRDAllowanceCharge allowance, IAbsoluteValueProvider item) {
 		String percentage = "";
@@ -232,9 +232,9 @@ public class ZUGFeRD2PullProvider implements IXMLProvider {
 	
 	/***
 	 * returns the XML for a charge or allowance on item total level
-	 * @param allowance
-	 * @param item
-	 * @return
+	 * @param allowance the allowance or charge
+	 * @param item the line
+	 * @return CII XML
 	 */
 	protected String getItemTotalAllowanceChargeStr(IZUGFeRDAllowanceCharge allowance, IAbsoluteValueProvider item) {
 		String percentage = "";

library/src/main/java/org/mustangproject/ZUGFeRD/ZUGFeRDExporterFromA3.java

@@ -678,6 +678,9 @@ public class ZUGFeRDExporterFromA3 extends XRExporter implements IZUGFeRDExporte
 	/**
 	 * Returns the AdobePDFSchema from the XMPMetadata if it exists.
 	 * If the overwrite flag is set or no AdobePDFSchema exists in the XMPMetadata, it is created, added and returned.
+	 *
+	 * @param xmp the metadata to attach to
+	 * @return the pdf schema
 	 */
 	protected AdobePDFSchema getAdobePDFSchema(XMPMetadata xmp) {
 		AdobePDFSchema pdf = xmp.getAdobePDFSchema();