javadoc corrections

This commit is contained in:
jstaerk
2022-11-07 07:21:53 +01:00
parent facef987c6
commit 3a776dcdea
8 changed files with 42 additions and 18 deletions

View File

@@ -8,14 +8,14 @@ import java.io.File;
import java.io.Serializable; 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 * thanks to Philip Helger for his library
*/ */
public class CIIToUBL { public class CIIToUBL {
/*** /***
* performs the actual conversion * performs the actual conversion
* @param input * @param input the CII file to convert
* @param output * @param output the UBL file to write to
*/ */
public void convert(File input, File output) { public void convert(File input, File output) {
ErrorList occurred=new ErrorList(); ErrorList occurred=new ErrorList();

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -678,6 +678,9 @@ public class ZUGFeRDExporterFromA3 extends XRExporter implements IZUGFeRDExporte
/** /**
* Returns the AdobePDFSchema from the XMPMetadata if it exists. * 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. * 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) { protected AdobePDFSchema getAdobePDFSchema(XMPMetadata xmp) {
AdobePDFSchema pdf = xmp.getAdobePDFSchema(); AdobePDFSchema pdf = xmp.getAdobePDFSchema();

20
pom.xml
View File

@@ -178,6 +178,26 @@
</execution> </execution>
</executions> </executions>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-toolchains-plugin</artifactId>
<version>3.1.0</version>
<executions>
<execution>
<goals>
<goal>toolchain</goal>
</goals>
</execution>
</executions>
<configuration>
<toolchains>
<jdk>
<version>1.8</version>
<vendor>openjdk</vendor>
</jdk>
</toolchains>
</configuration>
</plugin>
</plugins> </plugins>
</build> </build>
</profile> </profile>