From 40a5af2aaea5889a48b2f36aaff40578423f2798 Mon Sep 17 00:00:00 2001 From: Robert Nelson Date: Sun, 22 Dec 2013 23:44:41 -0800 Subject: [PATCH] Fixup more documentation links --- doc/JXG.Util.html | 4 +- doc/aes.html | 4 +- doc/aes.js.html | 4 +- doc/armor.html | 4 +- doc/armor.js.html | 4 +- doc/base64.html | 4 +- doc/base64.js.html | 4 +- doc/blowfish.html | 4 +- doc/blowfish.js.html | 4 +- doc/cast5.html | 4 +- doc/cast5.js.html | 4 +- doc/cfb.html | 10 +- doc/cfb.js.html | 10 +- doc/cleartext.js.html | 16 +- doc/compressed.html | 16 +- doc/compressed.js.html | 8 +- doc/config-config.html | 4 +- doc/config.html | 4 +- doc/config.js.html | 4 +- doc/config.localStorage.js.html | 4 +- doc/config_localStorage.html | 4 +- doc/crypto.html | 6 +- doc/crypto.js.html | 6 +- doc/des.html | 4 +- doc/des.js.html | 4 +- doc/dsa.html | 4 +- doc/dsa.js.html | 4 +- doc/elgamal.html | 4 +- doc/elgamal.js.html | 4 +- doc/enums.js.html | 82 +++--- doc/global.html | 140 +++++----- doc/index.html | 4 +- doc/index.js.html | 4 +- doc/jsbn.html | 4 +- doc/jsbn.js.html | 4 +- doc/jxg.js.html | 4 +- doc/key.js.html | 64 ++--- doc/keyid.html | 4 +- doc/keyid.js.html | 4 +- doc/keyring.html | 20 +- doc/keyring.js.html | 12 +- doc/literal.html | 8 +- doc/literal.js.html | 6 +- doc/localstore.html | 4 +- doc/localstore.js.html | 4 +- doc/marker.html | 8 +- doc/marker.js.html | 6 +- doc/md5.html | 4 +- doc/md5.js.html | 4 +- doc/message.js.html | 34 +-- doc/module-cleartext-CleartextMessage.html | 18 +- doc/module-cleartext.html | 8 +- doc/module-key-Key.html | 72 ++--- doc/module-key-SubKey.html | 20 +- doc/module-key-User.html | 30 +-- doc/module-key.html | 8 +- doc/module-message-Message.html | 42 +-- doc/module-message.html | 16 +- doc/module-openpgp.html | 28 +- doc/mpi.html | 4 +- doc/mpi.js.html | 4 +- doc/one_pass_signature.html | 4 +- doc/one_pass_signature.js.html | 4 +- doc/openpgp.js.html | 32 +-- doc/packet.html | 4 +- doc/packet.js.html | 4 +- doc/packetlist.html | 10 +- doc/packetlist.js.html | 8 +- doc/pkcs1.html | 4 +- doc/pkcs1.js.html | 4 +- doc/public_key.html | 4 +- doc/public_key.js.html | 4 +- doc/public_key_encrypted_session_key.html | 10 +- doc/public_key_encrypted_session_key.js.html | 8 +- doc/public_subkey.html | 4 +- doc/public_subkey.js.html | 4 +- doc/random.html | 4 +- doc/random.js.html | 4 +- doc/ripe-md.html | 4 +- doc/ripe-md.js.html | 4 +- doc/rsa.html | 4 +- doc/rsa.js.html | 4 +- doc/s2k.html | 4 +- doc/s2k.js.html | 4 +- doc/secret_key.html | 4 +- doc/secret_key.js.html | 4 +- doc/secret_subkey.html | 4 +- doc/secret_subkey.js.html | 4 +- doc/sha.html | 4 +- doc/sha.js.html | 4 +- doc/signature.html | 4 +- doc/signature.js.html | 4 +- doc/signature.js_.html | 12 +- doc/signature_.html | 60 ++--- doc/sym_encrypted_integrity_protected.html | 4 +- doc/sym_encrypted_integrity_protected.js.html | 4 +- doc/sym_encrypted_session_key.html | 8 +- doc/sym_encrypted_session_key.js.html | 6 +- doc/symmetrically_encrypted.html | 8 +- doc/symmetrically_encrypted.js.html | 6 +- doc/twofish.html | 4 +- doc/twofish.js.html | 4 +- doc/user_attribute.html | 8 +- doc/user_attribute.js.html | 6 +- doc/userid.html | 8 +- doc/userid.js.html | 6 +- doc/util-Util.html | 6 +- doc/util.html | 4 +- doc/util.js.html | 4 +- resources/keyring.js | 10 +- resources/openpgp.js | 252 +++++++++--------- resources/openpgp.min.js | 2 +- src/cleartext.js | 12 +- src/crypto/cfb.js | 6 +- src/crypto/crypto.js | 2 +- src/enums.js | 78 +++--- src/key.js | 60 ++--- src/keyring/keyring.js | 8 +- src/message.js | 30 +-- src/openpgp.js | 28 +- src/packet/compressed.js | 4 +- src/packet/literal.js | 2 +- src/packet/marker.js | 2 +- src/packet/packetlist.js | 4 +- .../public_key_encrypted_session_key.js | 4 +- src/packet/signature.js | 8 +- src/packet/sym_encrypted_session_key.js | 2 +- src/packet/symmetrically_encrypted.js | 2 +- src/packet/user_attribute.js | 2 +- src/packet/userid.js | 2 +- 130 files changed, 857 insertions(+), 827 deletions(-) diff --git a/doc/JXG.Util.html b/doc/JXG.Util.html index a6fe92e9..8b874660 100644 --- a/doc/JXG.Util.html +++ b/doc/JXG.Util.html @@ -554,13 +554,13 @@ EXAMPLES:
diff --git a/doc/aes.html b/doc/aes.html index c4a7ad89..9e7a35ef 100644 --- a/doc/aes.html +++ b/doc/aes.html @@ -105,13 +105,13 @@
diff --git a/doc/aes.js.html b/doc/aes.js.html index 9b2f5d02..66b892e5 100644 --- a/doc/aes.js.html +++ b/doc/aes.js.html @@ -543,13 +543,13 @@ for (var i in types) {
diff --git a/doc/armor.html b/doc/armor.html index 6caa68d8..3dfab024 100644 --- a/doc/armor.html +++ b/doc/armor.html @@ -1348,13 +1348,13 @@ given base64 encoded checksum
diff --git a/doc/armor.js.html b/doc/armor.js.html index db3e1499..2e88ab77 100644 --- a/doc/armor.js.html +++ b/doc/armor.js.html @@ -406,13 +406,13 @@ module.exports = {
diff --git a/doc/base64.html b/doc/base64.html index 8cc64083..7b2a87e3 100644 --- a/doc/base64.html +++ b/doc/base64.html @@ -105,13 +105,13 @@
diff --git a/doc/base64.js.html b/doc/base64.js.html index de931b60..95a414e4 100644 --- a/doc/base64.js.html +++ b/doc/base64.js.html @@ -122,13 +122,13 @@ module.exports = {
diff --git a/doc/blowfish.html b/doc/blowfish.html index 6900bf21..9f4925fc 100644 --- a/doc/blowfish.html +++ b/doc/blowfish.html @@ -105,13 +105,13 @@
diff --git a/doc/blowfish.js.html b/doc/blowfish.js.html index e7b23e26..ce9bc865 100644 --- a/doc/blowfish.js.html +++ b/doc/blowfish.js.html @@ -449,13 +449,13 @@ module.exports.blockSize = BF.prototype.blockSize = 16;
diff --git a/doc/cast5.html b/doc/cast5.html index 3f99f90e..7e0f5e64 100644 --- a/doc/cast5.html +++ b/doc/cast5.html @@ -105,13 +105,13 @@
diff --git a/doc/cast5.js.html b/doc/cast5.js.html index 6c9aa79b..f9beac23 100644 --- a/doc/cast5.js.html +++ b/doc/cast5.js.html @@ -640,13 +640,13 @@ module.exports.keySize = cast5.prototype.keySize = 16;
diff --git a/doc/cfb.html b/doc/cfb.html index 2aa9a58c..238b1e77 100644 --- a/doc/cfb.html +++ b/doc/cfb.html @@ -145,7 +145,7 @@ blockcipher to decrypt a message -openpgp_cipher_block_fn +openpgp_block_cipher_fn @@ -406,7 +406,7 @@ using the specified blockcipher to encrypt a message -openpgp_cipher_block_fn +openpgp_block_cipher_fn @@ -642,7 +642,7 @@ using the specified blockcipher to encrypt a message -openpgp_block_cipher_fn +openpgp_block_cipher_fn @@ -815,13 +815,13 @@ using the specified blockcipher to encrypt a message
diff --git a/doc/cfb.js.html b/doc/cfb.js.html index 577ee6a8..658567e1 100644 --- a/doc/cfb.js.html +++ b/doc/cfb.js.html @@ -56,7 +56,7 @@ module.exports = { /** * Block cipher function - * @callback openpgp_cipher_block_fn + * @callback openpgp_block_cipher_fn * @param {openpgp_byte_array} block A block to perform operations on * @param {openpgp_byte_array} key to use in encryption/decryption * @return {openpgp_byte_array} Encrypted/decrypted block @@ -69,7 +69,7 @@ module.exports = { * using the specified blockcipher to encrypt a message * @param {String} prefixrandom random bytes of block_size length provided * as a string to be used in prefixing the data - * @param {openpgp_cipher_block_fn} blockcipherfn the algorithm encrypt function to encrypt + * @param {openpgp_block_cipher_fn} blockcipherfn the algorithm encrypt function to encrypt * data in one block_size encryption. * @param {Integer} block_size the block size in bytes of the algorithm used * @param {String} plaintext data to be encrypted provided as a string @@ -211,7 +211,7 @@ module.exports = { /** * This function decrypts a given plaintext using the specified * blockcipher to decrypt a message - * @param {openpgp_cipher_block_fn} blockcipherfn The algorithm _encrypt_ function to encrypt + * @param {openpgp_block_cipher_fn} blockcipherfn The algorithm _encrypt_ function to encrypt * data in one block_size encryption. * @param {Integer} block_size the block size in bytes of the algorithm used * @param {String} plaintext ciphertext to be decrypted provided as a string @@ -346,13 +346,13 @@ module.exports = {
diff --git a/doc/cleartext.js.html b/doc/cleartext.js.html index 6f1a9b48..c7e9b9c8 100644 --- a/doc/cleartext.js.html +++ b/doc/cleartext.js.html @@ -54,7 +54,7 @@ var armor = require('./encoding/armor.js'); * @classdesc Class that represents an OpenPGP cleartext signed message. * See http://tools.ietf.org/html/rfc4880#section-7 * @param {String} text The cleartext of the signed message - * @param {packetlist} packetlist The packetlist with signature packets or undefined + * @param {module:packet/packetlist} packetlist The packetlist with signature packets or undefined * if message not yet signed */ @@ -69,7 +69,7 @@ function CleartextMessage(text, packetlist) { /** * Returns the key IDs of the keys that signed the cleartext message - * @return {Array<keyid>} array of keyid objects + * @return {Array<module:type/keyid>} array of keyid objects */ CleartextMessage.prototype.getSigningKeyIds = function() { var keyIds = []; @@ -82,7 +82,7 @@ CleartextMessage.prototype.getSigningKeyIds = function() { /** * Sign the cleartext message - * @param {Array<Key>} privateKeys private keys with decrypted secret key data for signing + * @param {Array<module:key~Key>} privateKeys private keys with decrypted secret key data for signing */ CleartextMessage.prototype.sign = function(privateKeys) { var packetlist = new packet.list(); @@ -103,8 +103,8 @@ CleartextMessage.prototype.sign = function(privateKeys) { /** * Verify signatures of cleartext signed message - * @param {Array<Key>} publicKeys public keys to verify signatures - * @return {Array<{keyid: keyid, valid: Boolean}>} list of signer's keyid and validity of signature + * @param {Array<module:key~Key>} publicKeys public keys to verify signatures + * @return {Array<{keyid: module:type/keyid, valid: Boolean}>} list of signer's keyid and validity of signature */ CleartextMessage.prototype.verify = function(publicKeys) { var result = []; @@ -153,7 +153,7 @@ CleartextMessage.prototype.armor = function() { /** * reads an OpenPGP cleartext signed message and returns a CleartextMessage object * @param {String} armoredText text to be parsed - * @return {CleartextMessage} new cleartext message object + * @return {module:cleartext~CleartextMessage} new cleartext message object */ function readArmored(armoredText) { var input = armor.decode(armoredText); @@ -178,13 +178,13 @@ exports.readArmored = readArmored;
diff --git a/doc/compressed.html b/doc/compressed.html index 15737525..68d273b0 100644 --- a/doc/compressed.html +++ b/doc/compressed.html @@ -219,7 +219,7 @@
-

packets :packetlist

+

packets :module:packet/packetlist

@@ -231,7 +231,7 @@