octoleo/plantuml
1
0
Fork 0
mirror of https://github.com/octoleo/plantuml.git synced 2024-11-22 04:55:10 +00:00
Code Issues Releases Wiki Activity

Merge pull request #1619 from The-Lum/ImproveDoc

Browse Source 
docs: improve `@deprecated` description
This commit is contained in:
PlantUML 2023-12-04 14:40:26 +01:00 committed by GitHub
commit 6c593c49d2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/net/sourceforge/plantuml/Option.java
View File

@ -112,6 +112,9 @@ public class Option {
private FileFormatOption fileFormatOption = new FileFormatOption(FileFormat.PNG); private FileFormatOption fileFormatOption = new FileFormatOption(FileFormat.PNG);
/**
* @deprecated Use {@link #setFileFormatOption(FileFormatOption)} instead
*/
@Deprecated @Deprecated
@ApiWarning(willBeRemoved = "in next major release") @ApiWarning(willBeRemoved = "in next major release")
final public void setFileFormat(FileFormat fileFormat) { final public void setFileFormat(FileFormat fileFormat) {

15
src/net/sourceforge/plantuml/SourceStringReader.java
View File

@ -106,6 +106,9 @@ public class SourceStringReader {
} }
} }
/**
* @deprecated Use {@link #outputImage(OutputStream)} instead
*/
@Deprecated @Deprecated
public String generateImage(OutputStream os) throws IOException { public String generateImage(OutputStream os) throws IOException {
return outputImage(os).getDescription(); return outputImage(os).getDescription();
@ -116,6 +119,9 @@ public class SourceStringReader {
} }
// ::comment when __CORE__ // ::comment when __CORE__
/**
* @deprecated Use {@link #outputImage(SFile)} instead
*/
@Deprecated @Deprecated
public String generateImage(SFile f) throws IOException { public String generateImage(SFile f) throws IOException {
return outputImage(f).getDescription(); return outputImage(f).getDescription();
@ -128,6 +134,9 @@ public class SourceStringReader {
} }
// ::done // ::done
/**
* @deprecated Use {@link #outputImage(OutputStream, FileFormatOption)} instead
*/
@Deprecated @Deprecated
public String generateImage(OutputStream os, FileFormatOption fileFormatOption) throws IOException { public String generateImage(OutputStream os, FileFormatOption fileFormatOption) throws IOException {
return outputImage(os, fileFormatOption).getDescription(); return outputImage(os, fileFormatOption).getDescription();
@ -137,6 +146,9 @@ public class SourceStringReader {
return outputImage(os, 0, fileFormatOption); return outputImage(os, 0, fileFormatOption);
} }
/**
* @deprecated Use {@link #outputImage(OutputStream, int)} instead
*/
@Deprecated @Deprecated
public String generateImage(OutputStream os, int numImage) throws IOException { public String generateImage(OutputStream os, int numImage) throws IOException {
return outputImage(os, numImage).getDescription(); return outputImage(os, numImage).getDescription();
@ -146,6 +158,9 @@ public class SourceStringReader {
return outputImage(os, numImage, new FileFormatOption(FileFormat.PNG)); return outputImage(os, numImage, new FileFormatOption(FileFormat.PNG));
} }
/**
* @deprecated Use {@link #outputImage(OutputStream, int, FileFormatOption)} instead
*/
@Deprecated @Deprecated
public String generateImage(OutputStream os, int numImage, FileFormatOption fileFormatOption) throws IOException { public String generateImage(OutputStream os, int numImage, FileFormatOption fileFormatOption) throws IOException {
return outputImage(os, numImage, fileFormatOption).getDescription(); return outputImage(os, numImage, fileFormatOption).getDescription();

5
src/net/sourceforge/plantuml/core/UmlSource.java
View File

@ -158,7 +158,10 @@ final public class UmlSource {
// return Collections.unmodifiableCollection(rawSource).iterator(); // return Collections.unmodifiableCollection(rawSource).iterator();
// } // }
/**
* @deprecated Use {@link #getPlainString(String)} instead,
* like <code>getPlainString("\n")</code>
*/
@Deprecated() @Deprecated()
public String getPlainString() { public String getPlainString() {
return getPlainString("\n"); return getPlainString("\n");