Skip to content

Commit 2cb7d76

Browse files
committed
cleanup docs
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
1 parent 060e0a1 commit 2cb7d76

1 file changed

Lines changed: 13 additions & 14 deletions

File tree

‎src/Crypto.chpl‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -574,10 +574,9 @@ module Crypto {
574574
575575
Initialization example,
576576
577-
.. literalinclude:: ../../../../test/library/packages/Crypto/doc-examples/CryptoExamples.chpl
578-
:language: chapel
579-
:start-after: START_EXAMPLE_0
580-
:end-before: STOP_EXAMPLE_0
577+
.. code-block:: chapel
578+
579+
var h = new Hash(Digest.SHA256);
581580
*/
582581
proc init(digestName: Digest) {
583582
init this;
@@ -790,10 +789,9 @@ module Crypto {
790789
791790
Initialization example,
792791
793-
.. literalinclude:: ../../../../test/library/packages/Crypto/doc-examples/CryptoExamples.chpl
794-
:language: chapel
795-
:start-after: START_EXAMPLE_1
796-
:end-before: STOP_EXAMPLE_1
792+
.. code-block:: chapel
793+
794+
var aes = new AES(256, CryptoChainMode.cbc);
797795
*/
798796
proc init(bits: int, mode: CryptoChainMode) {
799797
var tmpCipher: CONST_EVP_CIPHER_PTR;
@@ -987,10 +985,9 @@ module Crypto {
987985
desired number of random values as specified by the argument. Halts for
988986
number of bytes less than 1 (invalid). For instance:
989987
990-
.. literalinclude:: ../../../../test/library/packages/Crypto/doc-examples/CryptoGetRandomBuffer.chpl
991-
:language: chapel
992-
:start-after: START_EXAMPLE
993-
:end-before: STOP_EXAMPLE
988+
.. code-block:: chapel
989+
990+
var a = (new CryptoRandom()).getRandomBuffer(5);
994991
995992
would give us a `CryptoBuffer` of size `5` and pre-initialized with
996993
values.
@@ -1014,6 +1011,7 @@ module Crypto {
10141011
}
10151012
}
10161013

1014+
@chplcheck.ignore("CamelCaseFunctions")
10171015
@chpldoc.nodoc
10181016
proc PBKDF2(userKey: string, saltBuff: CryptoBuffer,
10191017
byteLen: int, iterCount: int, digestName: string) {
@@ -1058,8 +1056,8 @@ module Crypto {
10581056
10591057
:arg iterCount: The iteration count used by OpenSSL to repeat the
10601058
`Update` primitive. Min. recommended value = 1000.
1061-
Greater the `iterCount`, greater the security of the
1062-
key.
1059+
Greater the `iterCount`, greater the security of the
1060+
key.
10631061
:type iterCount: `int`
10641062
10651063
:arg digest: An object of class 'Hash'. This decides the Hashing function
@@ -1294,6 +1292,7 @@ module Crypto {
12941292
`C_OpenSSL documentation <https://www.openssl.org/docs/manmaster/man3/>`_
12951293
of the reference version for the usage of this module.
12961294
*/
1295+
@chplcheck.ignore("PascalCaseModules")
12971296
module C_OpenSSL {
12981297
// The RSA module include needs special treatment since it uses
12991298
// I as an argument even though Chapel will have already included

0 commit comments

Comments
 (0)