Chromium Code Reviews| Index: lib/src/hash.dart |
| diff --git a/lib/src/hash.dart b/lib/src/hash.dart |
| index 03d4b1cb770a35d486d8f3776d2b050f98142848..5defe575a1cea9784b8ac891cabf24980e01aea8 100644 |
| --- a/lib/src/hash.dart |
| +++ b/lib/src/hash.dart |
| @@ -4,42 +4,30 @@ |
| library crypto.hash; |
| -/** |
| - * Interface for cryptographic hash functions. |
| - * |
| - * The [add] method is used to add data to the hash. The [close] method |
| - * is used to extract the message digest. |
| - * |
| - * Once the [close] method has been called no more data can be added using the |
| - * [add] method. If [add] is called after the first call to [close] a |
| - * HashException is thrown. |
| - * |
| - * If multiple instances of a given Hash is needed the [newInstance] |
| - * method can provide a new instance. |
| - */ |
| +/// An interface for cryptographic hash functions. |
| +/// |
| +/// The [add] method adds data to the hash. The [close] method extracts the |
| +/// message digest. |
| +/// |
| +/// If multiple instances of a given Hash is needed, the [newInstance] method can |
|
Bob Nystrom
2015/09/17 17:11:56
Long.
nweiz
2015/09/17 20:06:41
Done.
|
| +/// provide a new instance. |
| // TODO(floitsch): make Hash implement Sink, EventSink or similar. |
| abstract class Hash { |
| - /** |
| - * Add a list of bytes to the hash computation. |
| - */ |
| + /// Add a list of bytes to the hash computation. |
| + /// |
| + /// If [this] has already been closed, throws a [StateError]. |
| void add(List<int> data); |
| - /** |
| - * Finish the hash computation and extract the message digest as |
| - * a list of bytes. |
| - */ |
| + /// Finish the hash computation and extract the message digest as a list of |
| + /// bytes. |
| List<int> close(); |
| - /** |
| - * Returns a new instance of this hash function. |
| - */ |
| + /// Returns a new instance of this hash function. |
| Hash newInstance(); |
| - /** |
| - * Internal block size of the hash in bytes. |
| - * |
| - * This is exposed for use by the HMAC class which needs to know the |
| - * block size for the [Hash] it is using. |
| - */ |
| + /// The internal block size of the hash in bytes. |
| + /// |
| + /// This is exposed for use by the [HMAC] class, which needs to know the block |
| + /// size for the [Hash] it uses. |
| int get blockSize; |
| } |