mirror of
https://github.com/openpgpjs/openpgpjs.git
synced 2025-10-14 00:59:29 +00:00
Remove @private JSDoc directives interfering with TS
This commit is contained in:
parent
ae4ed1fbf3
commit
b094274d98
@ -19,7 +19,6 @@
|
|||||||
* @fileoverview Implementation of RFC 3394 AES Key Wrap & Key Unwrap funcions
|
* @fileoverview Implementation of RFC 3394 AES Key Wrap & Key Unwrap funcions
|
||||||
* @see module:crypto/public_key/elliptic/ecdh
|
* @see module:crypto/public_key/elliptic/ecdh
|
||||||
* @module crypto/aes_kw
|
* @module crypto/aes_kw
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import * as cipher from './cipher';
|
import * as cipher from './cipher';
|
||||||
|
@ -1,7 +1,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview Symmetric cryptography functions
|
* @fileoverview Symmetric cryptography functions
|
||||||
* @module crypto/cipher
|
* @module crypto/cipher
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import aes from './aes';
|
import aes from './aes';
|
||||||
|
@ -21,7 +21,6 @@
|
|||||||
* @fileoverview Provides functions for asymmetric encryption and decryption as
|
* @fileoverview Provides functions for asymmetric encryption and decryption as
|
||||||
* well as key generation and parameter handling for all public-key cryptosystems.
|
* well as key generation and parameter handling for all public-key cryptosystems.
|
||||||
* @module crypto/crypto
|
* @module crypto/crypto
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import publicKey from './public_key';
|
import publicKey from './public_key';
|
||||||
|
@ -3,7 +3,6 @@
|
|||||||
* @see {@link https://github.com/asmcrypto/asmcrypto.js|asmCrypto}
|
* @see {@link https://github.com/asmcrypto/asmcrypto.js|asmCrypto}
|
||||||
* @see {@link https://github.com/indutny/hash.js|hash.js}
|
* @see {@link https://github.com/indutny/hash.js|hash.js}
|
||||||
* @module crypto/hash
|
* @module crypto/hash
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { Sha1 } from '@openpgp/asmcrypto.js/dist_es8/hash/sha1/sha1';
|
import { Sha1 } from '@openpgp/asmcrypto.js/dist_es8/hash/sha1/sha1';
|
||||||
|
@ -1,7 +1,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview This module implements HKDF using either the WebCrypto API or Node.js' crypto API.
|
* @fileoverview This module implements HKDF using either the WebCrypto API or Node.js' crypto API.
|
||||||
* @module crypto/hkdf
|
* @module crypto/hkdf
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import enums from '../enums';
|
import enums from '../enums';
|
||||||
|
@ -7,7 +7,6 @@
|
|||||||
* @see module:crypto/random
|
* @see module:crypto/random
|
||||||
* @see module:crypto/hash
|
* @see module:crypto/hash
|
||||||
* @module crypto
|
* @module crypto
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import * as cipher from './cipher';
|
import * as cipher from './cipher';
|
||||||
|
@ -19,7 +19,6 @@
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @module crypto/mode/cfb
|
* @module crypto/mode/cfb
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { AES_CFB } from '@openpgp/asmcrypto.js/dist_es8/aes/cfb';
|
import { AES_CFB } from '@openpgp/asmcrypto.js/dist_es8/aes/cfb';
|
||||||
|
@ -19,7 +19,6 @@
|
|||||||
* @fileoverview This module wraps native AES-GCM en/decryption for both
|
* @fileoverview This module wraps native AES-GCM en/decryption for both
|
||||||
* the WebCrypto api as well as node.js' crypto api.
|
* the WebCrypto api as well as node.js' crypto api.
|
||||||
* @module crypto/mode/gcm
|
* @module crypto/mode/gcm
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { AES_GCM } from '@openpgp/asmcrypto.js/dist_es8/aes/gcm';
|
import { AES_GCM } from '@openpgp/asmcrypto.js/dist_es8/aes/gcm';
|
||||||
|
@ -18,7 +18,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview This module implements AES-OCB en/decryption.
|
* @fileoverview This module implements AES-OCB en/decryption.
|
||||||
* @module crypto/mode/ocb
|
* @module crypto/mode/ocb
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import * as ciphers from '../cipher';
|
import * as ciphers from '../cipher';
|
||||||
|
@ -21,7 +21,6 @@
|
|||||||
* @see module:crypto/public_key/elliptic/ecdh
|
* @see module:crypto/public_key/elliptic/ecdh
|
||||||
* @see PublicKeyEncryptedSessionKeyPacket
|
* @see PublicKeyEncryptedSessionKeyPacket
|
||||||
* @module crypto/pkcs1
|
* @module crypto/pkcs1
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { getRandomBytes } from './random';
|
import { getRandomBytes } from './random';
|
||||||
|
@ -18,7 +18,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview A Digital signature algorithm implementation
|
* @fileoverview A Digital signature algorithm implementation
|
||||||
* @module crypto/public_key/dsa
|
* @module crypto/public_key/dsa
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
import { getRandomBigInteger } from '../random';
|
import { getRandomBigInteger } from '../random';
|
||||||
import util from '../../util';
|
import util from '../../util';
|
||||||
|
@ -18,7 +18,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview ElGamal implementation
|
* @fileoverview ElGamal implementation
|
||||||
* @module crypto/public_key/elgamal
|
* @module crypto/public_key/elgamal
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import util from '../../util';
|
import util from '../../util';
|
||||||
|
@ -18,7 +18,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview Key encryption and decryption for RFC 6637 ECDH
|
* @fileoverview Key encryption and decryption for RFC 6637 ECDH
|
||||||
* @module crypto/public_key/elliptic/ecdh
|
* @module crypto/public_key/elliptic/ecdh
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import nacl from '@openpgp/tweetnacl/nacl-fast-light';
|
import nacl from '@openpgp/tweetnacl/nacl-fast-light';
|
||||||
|
@ -1,7 +1,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview Key encryption and decryption for RFC 6637 ECDH
|
* @fileoverview Key encryption and decryption for RFC 6637 ECDH
|
||||||
* @module crypto/public_key/elliptic/ecdh
|
* @module crypto/public_key/elliptic/ecdh
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import nacl from '@openpgp/tweetnacl/nacl-fast-light';
|
import nacl from '@openpgp/tweetnacl/nacl-fast-light';
|
||||||
|
@ -18,7 +18,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview Implementation of ECDSA following RFC6637 for Openpgpjs
|
* @fileoverview Implementation of ECDSA following RFC6637 for Openpgpjs
|
||||||
* @module crypto/public_key/elliptic/ecdsa
|
* @module crypto/public_key/elliptic/ecdsa
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import enums from '../../../enums';
|
import enums from '../../../enums';
|
||||||
|
@ -18,7 +18,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview Implementation of EdDSA following RFC4880bis-03 for OpenPGP
|
* @fileoverview Implementation of EdDSA following RFC4880bis-03 for OpenPGP
|
||||||
* @module crypto/public_key/elliptic/eddsa
|
* @module crypto/public_key/elliptic/eddsa
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import sha512 from 'hash.js/lib/hash/sha/512';
|
import sha512 from 'hash.js/lib/hash/sha/512';
|
||||||
|
@ -19,7 +19,6 @@
|
|||||||
* @fileoverview Implementation of legacy EdDSA following RFC4880bis-03 for OpenPGP.
|
* @fileoverview Implementation of legacy EdDSA following RFC4880bis-03 for OpenPGP.
|
||||||
* This key type has been deprecated by the crypto-refresh RFC.
|
* This key type has been deprecated by the crypto-refresh RFC.
|
||||||
* @module crypto/public_key/elliptic/eddsa_legacy
|
* @module crypto/public_key/elliptic/eddsa_legacy
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import sha512 from 'hash.js/lib/hash/sha/512';
|
import sha512 from 'hash.js/lib/hash/sha/512';
|
||||||
|
@ -22,7 +22,6 @@
|
|||||||
* @see module:crypto/public_key/elliptic/ecdsa
|
* @see module:crypto/public_key/elliptic/ecdsa
|
||||||
* @see module:crypto/public_key/elliptic/eddsa
|
* @see module:crypto/public_key/elliptic/eddsa
|
||||||
* @module crypto/public_key/elliptic
|
* @module crypto/public_key/elliptic
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { CurveWithOID, generate, getPreferredHashAlgo } from './oid_curves';
|
import { CurveWithOID, generate, getPreferredHashAlgo } from './oid_curves';
|
||||||
|
@ -18,7 +18,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview Wrapper for a KeyPair of an curve from indutny/elliptic library
|
* @fileoverview Wrapper for a KeyPair of an curve from indutny/elliptic library
|
||||||
* @module crypto/public_key/elliptic/indutnyKey
|
* @module crypto/public_key/elliptic/indutnyKey
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import config from '../../../config';
|
import config from '../../../config';
|
||||||
|
@ -18,7 +18,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview Wrapper of an instance of an Elliptic Curve
|
* @fileoverview Wrapper of an instance of an Elliptic Curve
|
||||||
* @module crypto/public_key/elliptic/curve
|
* @module crypto/public_key/elliptic/curve
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import nacl from '@openpgp/tweetnacl/nacl-fast-light';
|
import nacl from '@openpgp/tweetnacl/nacl-fast-light';
|
||||||
|
@ -1,7 +1,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview Asymmetric cryptography functions
|
* @fileoverview Asymmetric cryptography functions
|
||||||
* @module crypto/public_key
|
* @module crypto/public_key
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import nacl from '@openpgp/tweetnacl/nacl-fast-light';
|
import nacl from '@openpgp/tweetnacl/nacl-fast-light';
|
||||||
|
@ -18,7 +18,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview Algorithms for probabilistic random prime generation
|
* @fileoverview Algorithms for probabilistic random prime generation
|
||||||
* @module crypto/public_key/prime
|
* @module crypto/public_key/prime
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import util from '../../util';
|
import util from '../../util';
|
||||||
|
@ -18,7 +18,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview RSA implementation
|
* @fileoverview RSA implementation
|
||||||
* @module crypto/public_key/rsa
|
* @module crypto/public_key/rsa
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { randomProbablePrime } from './prime';
|
import { randomProbablePrime } from './prime';
|
||||||
|
@ -20,7 +20,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview Provides tools for retrieving secure randomness from browsers or Node.js
|
* @fileoverview Provides tools for retrieving secure randomness from browsers or Node.js
|
||||||
* @module crypto/random
|
* @module crypto/random
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
import util from '../util';
|
import util from '../util';
|
||||||
|
|
||||||
|
@ -1,7 +1,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview Provides functions for asymmetric signing and signature verification
|
* @fileoverview Provides functions for asymmetric signing and signature verification
|
||||||
* @module crypto/signature
|
* @module crypto/signature
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import publicKey from './public_key';
|
import publicKey from './public_key';
|
||||||
|
@ -13,7 +13,6 @@
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @module encoding/base64
|
* @module encoding/base64
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import * as stream from '@openpgp/web-stream-tools';
|
import * as stream from '@openpgp/web-stream-tools';
|
||||||
|
@ -1,7 +1,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview Provides helpers methods for key module
|
* @fileoverview Provides helpers methods for key module
|
||||||
* @module key/helper
|
* @module key/helper
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import {
|
import {
|
||||||
|
@ -1,6 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
* @module key/User
|
* @module key/User
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import enums from '../enums';
|
import enums from '../enums';
|
||||||
|
@ -18,7 +18,6 @@
|
|||||||
/**
|
/**
|
||||||
* @fileoverview Functions for reading and writing packets
|
* @fileoverview Functions for reading and writing packets
|
||||||
* @module packet/packet
|
* @module packet/packet
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import * as stream from '@openpgp/web-stream-tools';
|
import * as stream from '@openpgp/web-stream-tools';
|
||||||
|
@ -19,7 +19,6 @@
|
|||||||
* Encoded symmetric key for ECDH (incl. legacy x25519)
|
* Encoded symmetric key for ECDH (incl. legacy x25519)
|
||||||
*
|
*
|
||||||
* @module type/ecdh_symkey
|
* @module type/ecdh_symkey
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import util from '../util';
|
import util from '../util';
|
||||||
|
@ -17,7 +17,6 @@
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @module type/keyid
|
* @module type/keyid
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import util from '../util';
|
import util from '../util';
|
||||||
|
@ -30,7 +30,6 @@
|
|||||||
* is constructed by omitting the first two octets. Only the truncated
|
* is constructed by omitting the first two octets. Only the truncated
|
||||||
* sequence of octets is the valid representation of a curve OID.
|
* sequence of octets is the valid representation of a curve OID.
|
||||||
* @module type/oid
|
* @module type/oid
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import util from '../util';
|
import util from '../util';
|
||||||
|
@ -25,7 +25,6 @@
|
|||||||
* private keyring, and to convert passphrases to encryption keys for
|
* private keyring, and to convert passphrases to encryption keys for
|
||||||
* symmetrically encrypted messages.
|
* symmetrically encrypted messages.
|
||||||
* @module type/s2k
|
* @module type/s2k
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import defaultConfig from '../../config';
|
import defaultConfig from '../../config';
|
||||||
|
@ -20,7 +20,6 @@
|
|||||||
/**
|
/**
|
||||||
* This object contains utility functions
|
* This object contains utility functions
|
||||||
* @module util
|
* @module util
|
||||||
* @private
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import * as stream from '@openpgp/web-stream-tools';
|
import * as stream from '@openpgp/web-stream-tools';
|
||||||
|
Loading…
x
Reference in New Issue
Block a user