louisdevie/mustangproject
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated javadocs

Browse Source
This commit is contained in:
jstaerk
2024-11-18 19:23:07 +01:00
parent a1eb76fbb9
commit 803778df57
3 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
library/src/main/java/org/mustangproject/Invoice.java
View File

@@ -478,7 +478,9 @@ public class Invoice implements IExportableTransaction {
} }
/*** /***
* for currency rounding differences to 5ct e.g. in Netherlands ("Rappenrundung") * set the cent e.g. to reach the next 5ct mark for currencies in certain countries
* e.g. in the Netherlands ("Rappenrundung")
* @param amount
* @return fluent setter * @return fluent setter
*/ */
public Invoice setRoundingAmount(BigDecimal amount) { public Invoice setRoundingAmount(BigDecimal amount) {
@@ -543,8 +545,8 @@ public class Invoice implements IExportableTransaction {
/*** /***
* this is wrong and only used from jackson * this is wrong and only used from jackson
* @param iza * @param iza the Array of allowances/charges
* @return * @return fluent setter
*/ */
public Invoice setZFAllowances(Allowance[] iza) { public Invoice setZFAllowances(Allowance[] iza) {
Allowances=new ArrayList<>(); Allowances=new ArrayList<>();
@@ -567,8 +569,8 @@ public class Invoice implements IExportableTransaction {
/*** /***
* this is wrong and only used from jackson * this is wrong and only used from jackson
* @param iza * @param iza the array of charges
* @return * @return fluent setter
*/ */
public Invoice setZFCharges(Charge[] iza) { public Invoice setZFCharges(Charge[] iza) {
Charges=new ArrayList<>(); Charges=new ArrayList<>();

4
library/src/main/java/org/mustangproject/XMLTools.java
View File

@@ -92,7 +92,7 @@ public class XMLTools extends XMLWriter {
/*** /***
* formats a number so that at least minDecimals are displayed but at the maximum maxDecimals are there, i.e. * formats a number so that at least minDecimals are displayed but at the maximum maxDecimals are there, i.e.
* cuts potential 0s off the end until minDecimals * cuts potential 0s off the end until minDecimals
* @param value * @param value the value to be formatted
* @param maxDecimals number of maximal scale * @param maxDecimals number of maximal scale
* @param minDecimals number of minimal scale * @param minDecimals number of minimal scale
* @return value as String with decimals in the specified range * @return value as String with decimals in the specified range
@@ -138,7 +138,7 @@ public class XMLTools extends XMLWriter {
} }
/*** /***
* relplaces some entities like < , > and & with their escaped pendant like &lt; * relplaces some entities like &lt; , &gt; and &amp; with their escaped pendant like &amp;lt;
* @param s the string * @param s the string
* @return the "safe" string * @return the "safe" string
*/ */

6
library/src/main/java/org/mustangproject/ZUGFeRD/ZUGFeRDInvoiceImporter.java
View File

@@ -101,7 +101,7 @@ public class ZUGFeRDInvoiceImporter {
/*** /***
* return the file names of all files embedded into the PDF * return the file names of all files embedded into the PDF
* @see for XML embedded files please use ZUGFeRDInvoiceImporter.getFileAttachmentsXML * @see ZUGFeRDInvoiceImporter for XML embedded files please use ZUGFeRDInvoiceImporter.getFileAttachmentsXML
* @return a ArrayList of FileAttachments, empty if none * @return a ArrayList of FileAttachments, empty if none
*/ */
public List<FileAttachment> getFileAttachmentsPDF() { public List<FileAttachment> getFileAttachmentsPDF() {
@@ -228,7 +228,7 @@ public class ZUGFeRDInvoiceImporter {
* set the xml of a CII invoice * set the xml of a CII invoice
* @param rawXML the xml string * @param rawXML the xml string
* @param doParse automatically parse input for zugferdImporter (not ZUGFeRDInvoiceImporter) * @param doParse automatically parse input for zugferdImporter (not ZUGFeRDInvoiceImporter)
* @throws IOException * @throws IOException if parsing xml throws it (unlikely its string based)
*/ */
public void setRawXML(byte[] rawXML, boolean doParse) throws IOException { public void setRawXML(byte[] rawXML, boolean doParse) throws IOException {
this.containsMeta = true; this.containsMeta = true;
@@ -248,7 +248,7 @@ public class ZUGFeRDInvoiceImporter {
/*** /***
* set the xml of a CII invoice, simple version * set the xml of a CII invoice, simple version
* @param rawXML the cii(?) as a string * @param rawXML the cii(?) as a string
* @throws IOException * @throws IOException if parsing xml throws it (unlikely its string based)
*/ */
public void setRawXML(byte[] rawXML) throws IOException { public void setRawXML(byte[] rawXML) throws IOException {
setRawXML(rawXML, true); setRawXML(rawXML, true);