Permalink
Browse files

Fixes for Javadoc warnings.

  • Loading branch information...
1 parent f424960 commit a4fe3e173b88674f3411ce300f94ff4029889d80 @Raptor399 Raptor399 committed Apr 1, 2013
@@ -928,7 +928,7 @@ public boolean isDisableSubtitles() {
}
/**
- * @deprecated Use {@link #setDisableSubtitles()} instead.
+ * @deprecated Use {@link #setDisableSubtitles(boolean)} instead.
*/
public void setMencoderDisableSubs(boolean value) {
setDisableSubtitles(value);
@@ -1111,7 +1111,7 @@ public boolean isMencoderForceFps() {
}
/**
- * @deprecated Use {@link #setAudioLanguages()} instead.
+ * @deprecated Use {@link #setAudioLanguages(String)} instead.
*/
public void setMencoderAudioLanguages(String value) {
setAudioLanguages(value);
@@ -1128,7 +1128,7 @@ public void setAudioLanguages(String value) {
}
/**
- * @deprecated Use {@link #setSubtitlesLanguages()} instead.
+ * @deprecated Use {@link #setSubtitlesLanguages(String)} instead.
*/
public void setMencoderSubLanguages(String value) {
setSubtitlesLanguages(value);
@@ -1145,7 +1145,7 @@ public void setSubtitlesLanguages(String value) {
}
/**
- * @deprecated Use {@link #setForcedSubtitleLanguage()} instead.
+ * @deprecated Use {@link #setForcedSubtitleLanguage(String)} instead.
*/
public void setMencoderForcedSubLanguage(String value) {
setForcedSubtitleLanguage(value);
@@ -1161,7 +1161,7 @@ public void setForcedSubtitleLanguage(String value) {
}
/**
- * @deprecated Use {@link #setForcedSubtitleTags()} instead.
+ * @deprecated Use {@link #setForcedSubtitleTags(String)} instead.
*/
public void setMencoderForcedSubTags(String value) {
setForcedSubtitleTags(value);
@@ -1334,7 +1334,8 @@ public void setMencoderYadif(boolean value) {
* upscale the video itself.
*
* @return True if MEncoder should be used, false otherwise.
- * @see {@link #getMencoderScaleX(int)}, {@link #getMencoderScaleY(int)}
+ * @see #getMencoderScaleX()
+ * @see #getMencoderScaleY()
*/
public boolean isMencoderScaler() {
return getBoolean(KEY_MENCODER_SCALER, false);
@@ -1345,7 +1346,8 @@ public boolean isMencoderScaler() {
* optimal resolution. Set to false to leave upscaling to the renderer.
*
* @param value Set to true if MEncoder should be used to upscale.
- * @see {@link #setMencoderScaleX(int)}, {@link #setMencoderScaleY(int)}
+ * @see #setMencoderScaleX(int)
+ * @see #setMencoderScaleY(int)
*/
public void setMencoderScaler(boolean value) {
configuration.setProperty(KEY_MENCODER_SCALER, value);
@@ -1472,8 +1474,6 @@ public boolean isThumbnailGenerationEnabled() {
* This only determines whether a thumbnailer (e.g. dcraw, MPlayer)
* is used to generate thumbnails. It does not reflect whether
* thumbnails should be displayed or not.
- *
- * @return boolean indicating whether thumbnail generation is enabled.
*/
@Deprecated
public void setThumbnailsEnabled(boolean value) {
@@ -655,7 +655,7 @@ TranscodeVirtualFolder getTranscodeFolder(boolean create) {
/**
* Adds the supplied DNLA resource to the internal list of child nodes,
* and sets the parent to the current node. Avoids the side-effects
- * associated with the {@link addChild(DLNAResource)} method.
+ * associated with the {@link #addChild(DLNAResource)} method.
*
* @param child the DLNA resource to add to this node's list of children
*/
@@ -1955,7 +1955,7 @@ public void checkThumbnail() {
* Called from Request/RequestV2 in response to thumbnail requests e.g. HEAD /get/0$1$0$42$3/thumbnail0000%5BExample.mkv
* Calls DLNAMediaInfo.generateThumbnail, which in turn calls DLNAMediaInfo.parse.
*
- * @param input InputFile to check or generate the thumbnail from.
+ * @param inputFile File to check or generate the thumbnail for.
*/
protected void checkThumbnail(InputFile inputFile) {
if (getMedia() != null && !getMedia().isThumbready() && PMS.getConfiguration().isThumbnailGenerationEnabled()) {
@@ -2158,7 +2158,7 @@ public long getLastModified() {
}
/**
- * @deprecated Use {@link #setLastModified()} instead.
+ * @deprecated Use {@link #setLastModified(long)} instead.
*
* Sets the timestamp at which this resource was last modified.
*
@@ -258,7 +258,7 @@ public static Player getPlayer(final Class<? extends Player> profileClass,
* and the first that reports it is compatible will be returned.
*
* @param resource
- * The {@link DLNAMediaResource} to match
+ * The {@link DLNAResource} to match
* @return The player if a match could be found, <code>null</code>
* otherwise.
* @since 1.60.0
@@ -135,10 +135,10 @@ public boolean isCompatible(DLNAResource resource) {
}
/**
- * Pick codecs for VLC based on formats the client supports;
+ * Pick codecs for VLC based on formats the renderer supports.
*
- * @param formats
- * @return
+ * @param renderer The {@link RendererConfiguration}.
+ * @return The codec configuration
*/
protected CodecConfig genConfig(RendererConfiguration renderer) {
CodecConfig config = new CodecConfig();
@@ -368,7 +368,7 @@ public static void convertFileFromUtf16ToUtf8(File inputFile, File outputFile) t
/**
* Determine whether a file is readable by trying to read it. This works around JDK bugs which
- * return the wrong results for {@link java.io.File.canRead()} on Windows, and in some cases, on Unix.
+ * return the wrong results for {@link java.io.File#canRead()} on Windows, and in some cases, on Unix.
* <p>
* Note: since this method accesses the filesystem, it should not be used in contexts in which performance is critical.
* Note: this method changes the file access time.
@@ -395,7 +395,7 @@ public static boolean isFileReadable(File file) {
/**
* Determine whether a file is writable by trying to write it. This works around JDK bugs which
- * return the wrong results for {@link java.io.File.canWrite()} on Windows and, in some cases, on Unix.
+ * return the wrong results for {@link java.io.File#canWrite()} on Windows and, in some cases, on Unix.
* <p>
* Note: since this method accesses the filesystem, it should not be used in contexts in which performance is critical.
* Note: this method changes the file access time and may change the file modification time.
@@ -440,7 +440,7 @@ public static boolean isFileWritable(File file) {
/**
* Determines whether the supplied directory is readable by trying to read its contents.
- * This works around JDK bugs which return the wrong results for {@link java.io.File.canRead()}
+ * This works around JDK bugs which return the wrong results for {@link java.io.File#canRead()}
* on Windows and possibly on Unix.
* <p>
* Note: since this method accesses the filesystem, it should not be used in contexts in which performance is critical.
@@ -473,7 +473,7 @@ public static boolean isDirectoryReadable(File dir) {
/**
* Determines whether the supplied directory is writable by trying to write a file to it.
- * This works around JDK bugs which return the wrong results for {@link java.io.File.canWrite()}
+ * This works around JDK bugs which return the wrong results for {@link java.io.File#canWrite()}
* on Windows and possibly on Unix.
* <p>
* Note: since this method accesses the filesystem, it should not be used in contexts in which performance is critical.
@@ -81,7 +81,7 @@ public static String convertURLToFileName(String url) {
/**
* Returns an abbreviated version of the supplied string.
*
- * @param The String to abbreviate.
+ * @param str The String to abbreviate.
* @return The abbreviated String.
*/
public static String abbreviate(String str) {

0 comments on commit a4fe3e1

Please sign in to comment.