Skip to content

Commit dbedcd4

Browse files
alecplalecpl
committed
PHPDOc fixes and cleanup
1 parent 89b1a67 commit dbedcd4

19 files changed

Lines changed: 152 additions & 319 deletions

‎Crypt/GPG.php‎

Lines changed: 51 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ class GPG
3737
*
3838
* This is the default signing mode.
3939
*
40-
* @see self::sign()
41-
* @see self::signFile()
40+
* @see GPG::sign()
41+
* @see GPG::signFile()
4242
*/
4343
public const SIGN_MODE_NORMAL = 1;
4444

@@ -48,8 +48,8 @@ class GPG
4848
* message is unencrypted, the message will still be readable. The message
4949
* text will be in the original encoding.
5050
*
51-
* @see self::sign()
52-
* @see self::signFile()
51+
* @see GPG::sign()
52+
* @see GPG::signFile()
5353
*/
5454
public const SIGN_MODE_CLEAR = 2;
5555

@@ -58,10 +58,10 @@ class GPG
5858
* signatures, only the signature data is returned. The original message
5959
* text may be distributed separately from the signature data. This is
6060
* useful for miltipart/signed email messages as per
61-
* {@link http://www.ietf.org/rfc/rfc3156.txt RFC 3156}.
61+
* {@link https://www.ietf.org/rfc/rfc3156.txt RFC 3156}.
6262
*
63-
* @see self::sign()
64-
* @see self::signFile()
63+
* @see GPG::sign()
64+
* @see GPG::signFile()
6565
*/
6666
public const SIGN_MODE_DETACHED = 3;
6767

@@ -70,7 +70,7 @@ class GPG
7070
*
7171
* Example: C3BC615AD9C766E5A85C1F2716D27458B1BBA1C4
7272
*
73-
* @see self::getFingerprint()
73+
* @see GPG::getFingerprint()
7474
*/
7575
public const FORMAT_NONE = 1;
7676

@@ -80,7 +80,7 @@ class GPG
8080
*
8181
* Example: C3BC 615A D9C7 66E5 A85C 1F27 16D2 7458 B1BB A1C4
8282
*
83-
* @see self::getFingerprint()
83+
* @see GPG::getFingerprint()
8484
*/
8585
public const FORMAT_CANONICAL = 2;
8686

@@ -89,7 +89,7 @@ class GPG
8989
*
9090
* Example: C3:BC:61:5A:D9:C7:66:E5:A8:5C:1F:27:16:D2:74:58:B1:BB:A1:C4
9191
*
92-
* @see self::getFingerprint()
92+
* @see GPG::getFingerprint()
9393
*/
9494
public const FORMAT_X509 = 3;
9595

@@ -198,7 +198,7 @@ class GPG
198198
*
199199
* @var Engine
200200
*
201-
* @see self::setEngine()
201+
* @see GPG::setEngine()
202202
*/
203203
protected $engine = null;
204204

@@ -216,8 +216,8 @@ class GPG
216216
* </code>
217217
*
218218
* @var array
219-
* @see self::addEncryptKey()
220-
* @see self::clearEncryptKeys()
219+
* @see GPG::addEncryptKey()
220+
* @see GPG::clearEncryptKeys()
221221
*/
222222
protected $encryptKeys = [];
223223

@@ -235,8 +235,8 @@ class GPG
235235
* </code>
236236
*
237237
* @var array
238-
* @see self::addSignKey()
239-
* @see self::clearSignKeys()
238+
* @see GPG::addSignKey()
239+
* @see GPG::clearSignKeys()
240240
*/
241241
protected $signKeys = [];
242242

@@ -254,8 +254,8 @@ class GPG
254254
* </code>
255255
*
256256
* @var array
257-
* @see self::addDecryptKey()
258-
* @see self::clearDecryptKeys()
257+
* @see GPG::addDecryptKey()
258+
* @see GPG::clearDecryptKeys()
259259
*/
260260
protected $decryptKeys = [];
261261

@@ -268,8 +268,8 @@ class GPG
268268
* </code>
269269
*
270270
* @var array
271-
* @see self::addPassphrase()
272-
* @see self::clearPassphrases()
271+
* @see GPG::addPassphrase()
272+
* @see GPG::clearPassphrases()
273273
*/
274274
protected $passphrases = [];
275275

@@ -388,8 +388,8 @@ public function getKeyEditor(): KeyEditor
388388
* Use the <kbd>debug</kbd> option and file a bug report if these
389389
* exceptions occur.
390390
*
391-
* @see self::addPassphrase()
392-
* @see self::clearPassphrases()
391+
* @see GPG::addPassphrase()
392+
* @see GPG::clearPassphrases()
393393
*/
394394
public function importKey($data): array
395395
{
@@ -583,8 +583,8 @@ public function deletePrivateKey($keyId): void
583583
* Gets the available keys in the keyring
584584
*
585585
* Calls GPG with the <kbd>--list-keys</kbd> command and grabs keys. See
586-
* the first section of <b>doc/DETAILS</b> in the
587-
* {@link http://www.gnupg.org/download/ GPG package} for a detailed
586+
* the first section of <kbd>doc/DETAILS</kbd> in the
587+
* {@link https://www.gnupg.org/download/ GPG package} for a detailed
588588
* description of how the GPG command output is parsed.
589589
*
590590
* @param string $keyId optional. Only keys with that match the specified
@@ -764,7 +764,7 @@ public function encryptFile($filename, $encryptedFile = null, $armor = self::ARM
764764
* Use the <kbd>debug</kbd> option and file a bug report if these
765765
* exceptions occur.
766766
*
767-
* @see self::decryptAndVerify()
767+
* @see GPG::decryptAndVerify()
768768
*/
769769
public function encryptAndSign($data, $armor = self::ARMOR_ASCII): string
770770
{
@@ -803,7 +803,7 @@ public function encryptAndSign($data, $armor = self::ARMOR_ASCII): string
803803
* Use the <kbd>debug</kbd> option and file a bug report if these
804804
* exceptions occur.
805805
*
806-
* @see self::decryptAndVerifyFile()
806+
* @see GPG::decryptAndVerifyFile()
807807
*/
808808
public function encryptAndSignFile($filename, $signedFile = null, $armor = self::ARMOR_ASCII): ?string
809809
{
@@ -1204,10 +1204,10 @@ public function verifyFile($filename, $signature = ''): array
12041204
*
12051205
* @return $this the current object, for fluent interface.
12061206
*
1207-
* @see self::decrypt()
1208-
* @see self::decryptFile()
1209-
* @see self::clearDecryptKeys()
1210-
* @see self::_addKey()
1207+
* @see GPG::decrypt()
1208+
* @see GPG::decryptFile()
1209+
* @see GPG::clearDecryptKeys()
1210+
* @see GPG::_addKey()
12111211
*
12121212
* @sensitive $passphrase
12131213
*/
@@ -1227,10 +1227,10 @@ public function addDecryptKey($key, $passphrase = null)
12271227
*
12281228
* @return $this the current object, for fluent interface.
12291229
*
1230-
* @see self::encrypt()
1231-
* @see self::encryptFile()
1232-
* @see self::clearEncryptKeys()
1233-
* @see self::_addKey()
1230+
* @see GPG::encrypt()
1231+
* @see GPG::encryptFile()
1232+
* @see GPG::clearEncryptKeys()
1233+
* @see GPG::_addKey()
12341234
*/
12351235
public function addEncryptKey($key)
12361236
{
@@ -1250,10 +1250,10 @@ public function addEncryptKey($key)
12501250
*
12511251
* @return $this the current object, for fluent interface.
12521252
*
1253-
* @see self::sign()
1254-
* @see self::signFile()
1255-
* @see self::clearSignKeys()
1256-
* @see self::_addKey()
1253+
* @see GPG::sign()
1254+
* @see GPG::signFile()
1255+
* @see GPG::clearSignKeys()
1256+
* @see GPG::_addKey()
12571257
*
12581258
* @sensitive $passphrase
12591259
*/
@@ -1272,9 +1272,9 @@ public function addSignKey($key, $passphrase = null)
12721272
*
12731273
* @return $this the current object, for fluent interface.
12741274
*
1275-
* @see self::clearPassphrases()
1276-
* @see self::importKey()
1277-
* @see self::exportKey()
1275+
* @see GPG::clearPassphrases()
1276+
* @see GPG::importKey()
1277+
* @see GPG::exportKey()
12781278
*
12791279
* @sensitive $passphrase
12801280
*/
@@ -1289,8 +1289,8 @@ public function addPassphrase($key, $passphrase)
12891289
*
12901290
* @return $this the current object, for fluent interface.
12911291
*
1292-
* @see self::decrypt()
1293-
* @see self::addDecryptKey()
1292+
* @see GPG::decrypt()
1293+
* @see GPG::addDecryptKey()
12941294
*/
12951295
public function clearDecryptKeys()
12961296
{
@@ -1303,8 +1303,8 @@ public function clearDecryptKeys()
13031303
*
13041304
* @return $this the current object, for fluent interface.
13051305
*
1306-
* @see self::encrypt()
1307-
* @see self::addEncryptKey()
1306+
* @see GPG::encrypt()
1307+
* @see GPG::addEncryptKey()
13081308
*/
13091309
public function clearEncryptKeys()
13101310
{
@@ -1317,8 +1317,8 @@ public function clearEncryptKeys()
13171317
*
13181318
* @return $this The current object, for fluent interface.
13191319
*
1320-
* @see self::sign()
1321-
* @see self::addSignKey()
1320+
* @see GPG::sign()
1321+
* @see GPG::addSignKey()
13221322
*/
13231323
public function clearSignKeys()
13241324
{
@@ -1331,9 +1331,9 @@ public function clearSignKeys()
13311331
*
13321332
* @return $this The current object, for fluent interface.
13331333
*
1334-
* @see self::importKey()
1335-
* @see self::exportKey()
1336-
* @see self::addPassphrase()
1334+
* @see GPG::importKey()
1335+
* @see GPG::exportKey()
1336+
* @see GPG::addPassphrase()
13371337
*/
13381338
public function clearPassphrases()
13391339
{
@@ -1929,8 +1929,8 @@ protected function _decryptAndVerify($data, $isFile, $outputFile, $ignoreVerifyE
19291929
* Gets the available keys in the keyring
19301930
*
19311931
* Calls GPG with the <kbd>--list-keys</kbd> command and grabs keys. See
1932-
* the first section of <b>doc/DETAILS</b> in the
1933-
* {@link http://www.gnupg.org/download/ GPG package} for a detailed
1932+
* the first section of <kbd>doc/DETAILS</kbd> in the
1933+
* {@link https://www.gnupg.org/download/ GPG package} for a detailed
19341934
* description of how the GPG command output is parsed.
19351935
*
19361936
* @param string $keyId optional. Only keys with that match the specified

0 commit comments

Comments
 (0)