Javadoc fixes in imagegen, sam, crypto

package.html files for imagegen
This commit is contained in:
zzz
2016-02-13 15:17:41 +00:00
parent 6ab5b84979
commit 071769679d
11 changed files with 35 additions and 15 deletions

View File

@@ -7,7 +7,7 @@ import java.security.MessageDigest;
* Utility methods useful for implementing identicon functionality. Methods are
* class methods for convenience.
* <p>
* Key method of interest is {@link getIdenticonCode} which converts IP address
* Key method of interest is {@link #getIdenticonCode} which converts IP address
* into identicon code.<br>
* <strong>IMPORTANT</strong>: <code>inetSalt</code> value must be set to
* reasonably long random string prior to invoking this method.
@@ -49,7 +49,7 @@ public class IdenticonUtil {
/**
* Returns current inetSalt value.
*
* @return
* @return the value
*/
public static String getInetSalt() {
return inetSalt;
@@ -117,7 +117,7 @@ public class IdenticonUtil {
* will be used to determine the value.
* @param remoteAddr
* HTTP requester's IP address. Optional if code was specified.
* @return
* @return the code
*/
public static int getIdenticonCode(String codeParam, String remoteAddr) {
int code = 0;

View File

@@ -100,7 +100,7 @@ public class NineBlockIdenticonRenderer2 implements IdenticonRenderer {
* Returns the size in pixels at which each patch will be rendered before
* they are scaled down to requested identicon size.
*
* @return
* @return the size
*/
public float getPatchSize() {
return patchSize;
@@ -161,7 +161,7 @@ public class NineBlockIdenticonRenderer2 implements IdenticonRenderer {
*
* <p>
* Size of the returned identicon image is determined by patchSize set using
* {@link setPatchSize}. Since a 9-block identicon consists of 3x3 patches,
* {@link #setPatchSize}. Since a 9-block identicon consists of 3x3 patches,
* width and height will be 3 times the patch size.
* </p>
*
@@ -304,7 +304,7 @@ public class NineBlockIdenticonRenderer2 implements IdenticonRenderer {
*
* @param c1
* @param c2
* @return
* @return the distance
*/
private float getColorDistance(Color c1, Color c2) {
float dx = c1.getRed() - c2.getRed();
@@ -317,7 +317,7 @@ public class NineBlockIdenticonRenderer2 implements IdenticonRenderer {
* Returns complementary color.
*
* @param color
* @return
* @return the complement
*/
private Color getComplementaryColor(Color color) {
return new Color(color.getRGB() ^ 0x00FFFFFF);

View File

@@ -0,0 +1,11 @@
<html>
<body>
<p>
The main identicon code is here.
The servlet is in net.i2p.imagegen.
There are minor modifications to remove dependencies on commons-logging
and the org.cache2k package.
From https://github.com/PauloMigAlmeida/identicon
</p>
</body>
</html>