git://git.nikiroo.be
/
nikiroo-utils.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (from parent 1:
e1168b3
)
Some jDoc fixes
author
Niki Roo
<niki@nikiroo.be>
Tue, 20 Jun 2017 11:57:27 +0000
(13:57 +0200)
committer
Niki Roo
<niki@nikiroo.be>
Tue, 20 Jun 2017 11:57:27 +0000
(13:57 +0200)
src/be/nikiroo/fanfix/Cache.java
patch
|
blob
|
blame
|
history
src/be/nikiroo/fanfix/Main.java
patch
|
blob
|
blame
|
history
src/be/nikiroo/fanfix/VersionCheck.java
patch
|
blob
|
blame
|
history
src/be/nikiroo/fanfix/bundles/ConfigBundle.java
patch
|
blob
|
blame
|
history
src/be/nikiroo/fanfix/bundles/package-info.java
patch
|
blob
|
blame
|
history
src/be/nikiroo/fanfix/data/Chapter.java
patch
|
blob
|
blame
|
history
src/be/nikiroo/fanfix/data/MetaData.java
patch
|
blob
|
blame
|
history
src/be/nikiroo/fanfix/data/Paragraph.java
patch
|
blob
|
blame
|
history
src/be/nikiroo/fanfix/output/BasicOutput.java
patch
|
blob
|
blame
|
history
src/be/nikiroo/fanfix/supported/BasicSupport.java
patch
|
blob
|
blame
|
history
src/be/nikiroo/fanfix/supported/YiffStar.java
patch
|
blob
|
blame
|
history
diff --git
a/src/be/nikiroo/fanfix/Cache.java
b/src/be/nikiroo/fanfix/Cache.java
index 7f603c1ba15f1c7e9d812d76941ce616e9d419b3..632c8441a35d596dfa6a2f2fc4c635542d1dd83e 100644
(file)
--- a/
src/be/nikiroo/fanfix/Cache.java
+++ b/
src/be/nikiroo/fanfix/Cache.java
@@
-14,7
+14,6
@@
import java.net.CookiePolicy;
import java.net.CookieStore;
import java.net.HttpCookie;
import java.net.HttpURLConnection;
import java.net.CookieStore;
import java.net.HttpCookie;
import java.net.HttpURLConnection;
-import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLConnection;
import java.net.URLEncoder;
import java.net.URL;
import java.net.URLConnection;
import java.net.URLEncoder;
@@
-303,17
+302,13
@@
public class Cache {
}
/**
}
/**
- * Open a resource (will load it from the cache if possible, or save it into
- * the cache after downloading if not) as an Image, then save it where
- * requested.
- * <p>
- * This version will not always work properly if the original file was not
- * downloaded before.
+ * Save the given resource as an image on disk using the default image
+ * format for content.
*
* @param url
*
* @param url
- * the resource
to open
- *
- *
@return the opened resource imag
e
+ * the resource
+ *
@param target
+ *
the target fil
e
*
* @throws IOException
* in case of I/O error
*
* @throws IOException
* in case of I/O error
@@
-357,7
+352,7
@@
public class Cache {
*
* @param uniqueID
* the unique ID
*
* @param uniqueID
* the unique ID
- *
+ *
* @return the content or NULL
*/
public InputStream getFromCache(String uniqueID) {
* @return the content or NULL
*/
public InputStream getFromCache(String uniqueID) {
@@
-428,7
+423,6
@@
public class Cache {
*
* @throws IOException
* in case of I/O error
*
* @throws IOException
* in case of I/O error
- * @throws URISyntaxException
*/
private void save(URL url, BasicSupport support, URL originalUrl)
throws IOException {
*/
private void save(URL url, BasicSupport support, URL originalUrl)
throws IOException {
@@
-518,6
+512,7
@@
public class Cache {
*
* @param url
* the url
*
* @param url
* the url
+ *
* @return the cached version if present, NULL if not
*/
private File getCached(URL url) {
* @return the cached version if present, NULL if not
*/
private File getCached(URL url) {
@@
-535,8
+530,9
@@
public class Cache {
* Get the cache resource from the cache if it is present for this unique
* ID.
*
* Get the cache resource from the cache if it is present for this unique
* ID.
*
- * @param url
- * the url
+ * @param uniqueID
+ * the id
+ *
* @return the cached version if present, NULL if not
*/
private File getCached(String uniqueID) {
* @return the cached version if present, NULL if not
*/
private File getCached(String uniqueID) {
diff --git
a/src/be/nikiroo/fanfix/Main.java
b/src/be/nikiroo/fanfix/Main.java
index 85d74928458e1589926bd0e0ab0f8d34be725c78..a282e7ccef83f7125735bf7bb810cc8e9dad4993 100644
(file)
--- a/
src/be/nikiroo/fanfix/Main.java
+++ b/
src/be/nikiroo/fanfix/Main.java
@@
-323,7
+323,7
@@
public class Main {
* List the stories of the given type from the {@link Library} (unless NULL
* is passed, in which case all stories will be listed).
*
* List the stories of the given type from the {@link Library} (unless NULL
* is passed, in which case all stories will be listed).
*
- * @param type
String
+ * @param type
* the type to list the known stories of, or NULL to list all
* stories
*
* the type to list the known stories of, or NULL to list all
* stories
*
diff --git
a/src/be/nikiroo/fanfix/VersionCheck.java
b/src/be/nikiroo/fanfix/VersionCheck.java
index 3f63bf5e8819621eabe3c4ebb9e0a022647d8778..be7fb919cb376f939457a989298deffd626af17e 100644
(file)
--- a/
src/be/nikiroo/fanfix/VersionCheck.java
+++ b/
src/be/nikiroo/fanfix/VersionCheck.java
@@
-12,6
+12,12
@@
import java.util.Map;
import be.nikiroo.utils.Version;
import be.nikiroo.utils.Version;
+/**
+ * Version checker: can check the current version of the program against a
+ * remote changelog, and list the missed updates and their description.
+ *
+ * @author niki
+ */
public class VersionCheck {
private static final String url = "https://github.com/nikiroo/fanfix/raw/master/changelog.md";
public class VersionCheck {
private static final String url = "https://github.com/nikiroo/fanfix/raw/master/changelog.md";
diff --git
a/src/be/nikiroo/fanfix/bundles/ConfigBundle.java
b/src/be/nikiroo/fanfix/bundles/ConfigBundle.java
index 9bf9dc69c07fa87286ad03c092d420839d9bff8b..7d38e36887bbbeb3812181017f2134dad369171f 100644
(file)
--- a/
src/be/nikiroo/fanfix/bundles/ConfigBundle.java
+++ b/
src/be/nikiroo/fanfix/bundles/ConfigBundle.java
@@
-11,6
+11,9
@@
import be.nikiroo.utils.resources.Bundle;
* @author niki
*/
public class ConfigBundle extends Bundle<Config> {
* @author niki
*/
public class ConfigBundle extends Bundle<Config> {
+ /**
+ * Create a new {@link ConfigBundle}.
+ */
public ConfigBundle() {
super(Config.class, Target.config);
}
public ConfigBundle() {
super(Config.class, Target.config);
}
diff --git
a/src/be/nikiroo/fanfix/bundles/package-info.java
b/src/be/nikiroo/fanfix/bundles/package-info.java
index 50db0118c36131b9b148aae76f46b6dde4dcd353..80cdd15f3450497a82f78fa82627b25da40a9f81 100644
(file)
--- a/
src/be/nikiroo/fanfix/bundles/package-info.java
+++ b/
src/be/nikiroo/fanfix/bundles/package-info.java
@@
-1,6
+1,6
@@
/**
* This package encloses the different
/**
* This package encloses the different
- * {@link be.nikiroo.utils.resources.
bundles.
Bundle} and their associated
+ * {@link be.nikiroo.utils.resources.Bundle} and their associated
* {@link java.lang.Enum}s used by the application.
*
* @author niki
* {@link java.lang.Enum}s used by the application.
*
* @author niki
diff --git
a/src/be/nikiroo/fanfix/data/Chapter.java
b/src/be/nikiroo/fanfix/data/Chapter.java
index 839d67b7c0ad2a079cbbc28ddf7e16019031b85f..7d0a51b306b62bfc7f821065a0c10e358be82075 100644
(file)
--- a/
src/be/nikiroo/fanfix/data/Chapter.java
+++ b/
src/be/nikiroo/fanfix/data/Chapter.java
@@
-79,7
+79,7
@@
public class Chapter implements Iterable<Paragraph> {
/**
* The included paragraphs.
*
/**
* The included paragraphs.
*
- * @param paragraph
e
s
+ * @param paragraphs
* the paragraphs to set
*/
public void setParagraphs(List<Paragraph> paragraphs) {
* the paragraphs to set
*/
public void setParagraphs(List<Paragraph> paragraphs) {
diff --git
a/src/be/nikiroo/fanfix/data/MetaData.java
b/src/be/nikiroo/fanfix/data/MetaData.java
index 189277d9480fb8ef4abf3f5b6b8646a5d74d303e..872baff2c1323a6e0f31f4a3b055273d7a4b07df 100644
(file)
--- a/
src/be/nikiroo/fanfix/data/MetaData.java
+++ b/
src/be/nikiroo/fanfix/data/MetaData.java
@@
-235,7
+235,7
@@
public class MetaData implements Cloneable, Comparable<MetaData> {
/**
* A unique value representing the story in the local library.
*
/**
* A unique value representing the story in the local library.
*
- * @param
u
uid
+ * @param
l
uid
* the luid to set
*/
public void setLuid(String luid) {
* the luid to set
*/
public void setLuid(String luid) {
diff --git
a/src/be/nikiroo/fanfix/data/Paragraph.java
b/src/be/nikiroo/fanfix/data/Paragraph.java
index e409c286ae2949be6242c772b6fb7a1783e6a51f..e4c94d45710bdb2f8b1cd9cd7f655f8ef490f861 100644
(file)
--- a/
src/be/nikiroo/fanfix/data/Paragraph.java
+++ b/
src/be/nikiroo/fanfix/data/Paragraph.java
@@
-33,11
+33,8
@@
public class Paragraph {
/**
* Create a new {@link Paragraph} with the given image.
*
/**
* Create a new {@link Paragraph} with the given image.
*
- * @param support
- * the support that will be used to fetch the image via
- * {@link Paragraph#getContentImage()}.
- * @param content
- * the content image of this paragraph
+ * @param imageUrl
+ * the image as an URL
*/
public Paragraph(URL imageUrl) {
this(ParagraphType.IMAGE, imageUrl.toString(), 0);
*/
public Paragraph(URL imageUrl) {
this(ParagraphType.IMAGE, imageUrl.toString(), 0);
diff --git
a/src/be/nikiroo/fanfix/output/BasicOutput.java
b/src/be/nikiroo/fanfix/output/BasicOutput.java
index 1ac6101d5852b57b0759b30294b4b87b1db4081f..909c8fe9707b6a76a05d6ebdf151193142757b6e 100644
(file)
--- a/
src/be/nikiroo/fanfix/output/BasicOutput.java
+++ b/
src/be/nikiroo/fanfix/output/BasicOutput.java
@@
-94,7
+94,8
@@
public abstract class BasicOutput {
}
/**
}
/**
- * Call {@link OutputType#valueOf(String.toUpperCase())}.
+ * Call {@link OutputType#valueOf(String)} after conversion to upper
+ * case.
*
* @param typeName
* the possible type name
*
* @param typeName
* the possible type name
@@
-107,8
+108,9
@@
public abstract class BasicOutput {
}
/**
}
/**
- * Call {@link OutputType#valueOf(String.toUpperCase())} but return NULL
- * for NULL and empty instead of raising an exception.
+ * Call {@link OutputType#valueOf(String)} after conversion to upper
+ * case but return NULL for NULL and empty instead of raising an
+ * exception.
*
* @param typeName
* the possible type name
*
* @param typeName
* the possible type name
@@
-124,8
+126,9
@@
public abstract class BasicOutput {
}
/**
}
/**
- * Call {@link OutputType#valueOf(String.toUpperCase())} but return NULL
- * in case of error instead of raising an exception.
+ * Call {@link OutputType#valueOf(String)} after conversion to upper
+ * case but return NULL in case of error instead of raising an
+ * exception.
*
* @param typeName
* the possible type name
*
* @param typeName
* the possible type name
@@
-238,9
+241,10
@@
public abstract class BasicOutput {
*
* @param type
* the new type
*
* @param type
* the new type
- * @param infoCover
- * TRUE to enable the creation of a .info file and a cover if
- * possible
+ * @param writeInfo
+ * TRUE to enable the creation of a .info file
+ * @param writeCover
+ * TRUE to enable the creation of a cover if possible
*
* @return this
*/
*
* @return this
*/
diff --git
a/src/be/nikiroo/fanfix/supported/BasicSupport.java
b/src/be/nikiroo/fanfix/supported/BasicSupport.java
index 0de0c4aa1eae107550b3266ed23820d558d830b9..fbdb47a9efe14795d53d6834be8c067239d29c9e 100644
(file)
--- a/
src/be/nikiroo/fanfix/supported/BasicSupport.java
+++ b/
src/be/nikiroo/fanfix/supported/BasicSupport.java
@@
-106,7
+106,8
@@
public abstract class BasicSupport {
}
/**
}
/**
- * Call {@link SupportType#valueOf(String.toUpperCase())}.
+ * Call {@link SupportType#valueOf(String)} after conversion to upper
+ * case.
*
* @param typeName
* the possible type name
*
* @param typeName
* the possible type name
@@
-119,8
+120,8
@@
public abstract class BasicSupport {
}
/**
}
/**
- * Call {@link SupportType#valueOf(String
.toUpperCase())} but return
- * NULL for NULL instead of raising exception.
+ * Call {@link SupportType#valueOf(String
)} after conversion to upper
+ *
case but return
NULL for NULL instead of raising exception.
*
* @param typeName
* the possible type name
*
* @param typeName
* the possible type name
@@
-136,8
+137,9
@@
public abstract class BasicSupport {
}
/**
}
/**
- * Call {@link SupportType#valueOf(String.toUpperCase())} but return
- * NULL in case of error instead of raising an exception.
+ * Call {@link SupportType#valueOf(String)} after conversion to upper
+ * case but return NULL in case of error instead of raising an
+ * exception.
*
* @param typeName
* the possible type name
*
* @param typeName
* the possible type name
@@
-192,6
+194,19
@@
public abstract class BasicSupport {
*/
protected abstract boolean isHtml();
*/
protected abstract boolean isHtml();
+ /**
+ * Return the {@link MetaData} of this story.
+ *
+ * @param source
+ * the source of the story
+ * @param in
+ * the input (the main resource)
+ *
+ * @return the associated {@link MetaData}
+ *
+ * @throws IOException
+ * in case of I/O error
+ */
protected abstract MetaData getMeta(URL source, InputStream in)
throws IOException;
protected abstract MetaData getMeta(URL source, InputStream in)
throws IOException;
@@
-313,9
+328,10
@@
public abstract class BasicSupport {
*
* @param url
* the story resource
*
* @param url
* the story resource
- *
* @param close
* close "this" and "in" when done
* @param close
* close "this" and "in" when done
+ * @param getDesc
+ * retrieve the description of the story, or not
* @param pg
* the optional progress reporter
*
* @param pg
* the optional progress reporter
*
@@
-576,6
+592,8
@@
public abstract class BasicSupport {
* Create a {@link Chapter} object from the given information, formatting
* the content as it should be.
*
* Create a {@link Chapter} object from the given information, formatting
* the content as it should be.
*
+ * @param source
+ * the source of the story
* @param number
* the chapter number
* @param name
* @param number
* the chapter number
* @param name
diff --git
a/src/be/nikiroo/fanfix/supported/YiffStar.java
b/src/be/nikiroo/fanfix/supported/YiffStar.java
index a2126db5fcfc55d991a336f9111b2430f9427e32..9813df890025a750aeec3af93a77f69de0dc15e0 100644
(file)
--- a/
src/be/nikiroo/fanfix/supported/YiffStar.java
+++ b/
src/be/nikiroo/fanfix/supported/YiffStar.java
@@
-265,6
+265,7
@@
class YiffStar extends BasicSupport {
* @return the {@link URL}
*
* @throws MalformedURLException
* @return the {@link URL}
*
* @throws MalformedURLException
+ * in case of data error
*/
private URL guest(String link) throws MalformedURLException {
if (link.contains("?")) {
*/
private URL guest(String link) throws MalformedURLException {
if (link.contains("?")) {