Skip to content

Commit f11c357

Browse files
committed
Added missing JavaDoc descriptions
1 parent 74e43ec commit f11c357

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

org.pathvisio.lib/src/main/java/org/pathvisio/libgpml/model/GPML2013aWriter.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ protected GPML2013aWriter(String xsdFile, Namespace nsGPML) {
8585
* @param validate if true, validate the dom structure before writing. If
8686
* there is a validation error, or the xsd is not in the
8787
* classpath, an exception will be thrown.
88-
* @throws ConverterException
88+
* @throws ConverterException when an {@link IOException} when the XML code is sent to the output stream
8989
*/
9090
@Override
9191
public void writeToXml(PathwayModel pathwayModel, OutputStream output, boolean validate) throws ConverterException {
@@ -120,7 +120,7 @@ public void writeToXml(PathwayModel pathwayModel, OutputStream output, boolean v
120120
* @param file the file to which the JDOM document should be saved.
121121
* @param validate if true, validate the dom structure before writing to
122122
* file.
123-
* @throws ConverterException
123+
* @throws ConverterException when an {@link IOException} happened during the creation of a {@link FileOutputStream}
124124
*/
125125
@Override
126126
public void writeToXml(PathwayModel pathwayModel, File file, boolean validate) throws ConverterException {
@@ -138,7 +138,7 @@ public void writeToXml(PathwayModel pathwayModel, File file, boolean validate) t
138138
* pathwayModel {@link PathwayModel} data.
139139
*
140140
* @param pathwayModel the pathway model to be written.
141-
* @throws ConverterException
141+
* @throws ConverterException when an {@link IOException} happened during the creation of a Jdom
142142
*/
143143
@Override
144144
public Document createJdom(PathwayModel pathwayModel) throws ConverterException {

org.pathvisio.lib/src/main/java/org/pathvisio/libgpml/model/GPMLFormatWriter.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public interface GPMLFormatWriter extends GPMLFormatVersion {
3434
*
3535
* @param pathwayModel the pathway model.
3636
* @return
37-
* @throws ConverterException
37+
* @throws ConverterException when an exception happened during the conversion
3838
*/
3939
Document createJdom(PathwayModel pathwayModel) throws ConverterException;
4040

@@ -44,7 +44,7 @@ public interface GPMLFormatWriter extends GPMLFormatVersion {
4444
* @param pathwayModel the pathway model.
4545
* @param file the file to write to.
4646
* @param validate if true, validate.
47-
* @throws ConverterException
47+
* @throws ConverterException when an exception happened during the conversion
4848
*/
4949
void writeToXml(PathwayModel pathwayModel, File file, boolean validate) throws ConverterException;
5050

@@ -54,7 +54,7 @@ public interface GPMLFormatWriter extends GPMLFormatVersion {
5454
* @param pathwayModel the pathway model.
5555
* @param out the output stream.
5656
* @param validate if true, validate.
57-
* @throws ConverterException
57+
* @throws ConverterException when an exception happened during the conversion
5858
*/
5959
void writeToXml(PathwayModel pathwayModel, OutputStream out, boolean validate) throws ConverterException;
6060

0 commit comments

Comments
 (0)