Update comments to be consistent (#73)

* fix: comments in `BaiscTypes.proto` Signed-off-by: Daniel Akhterov <[email protected]> * fix: comments in services protobuf files Signed-off-by: Daniel Akhterov <[email protected]> * fix: should use max line length of 100 not 80 for BasicTypes Signed-off-by: Daniel Akhterov <[email protected]> * fix: incorrectly ending comment twice Signed-off-by: Daniel Akhterov <[email protected]> * fix: update comments in mirror and streams Signed-off-by: Daniel Akhterov <[email protected]>
hashgraph · Aug 26, 2021 · 4b2a8bf · 4b2a8bf
1 parent 03115a3
commit 4b2a8bf
Show file tree

Hide file tree

Showing 90 changed files with 6,456 additions and 1,753 deletions.
diff --git a/mirror/consensus_service.proto b/mirror/consensus_service.proto
@@ -22,46 +22,79 @@ syntax = "proto3";
 
 package com.hedera.mirror.api.proto;
 
-option java_multiple_files = true; // Required for the reactor-grpc generator to work correctly
+/**
+ * Required for the reactor-grpc generator to work correctly
+ */
+option java_multiple_files = true;
+
 option java_package = "com.hedera.mirror.api.proto";
 
 import "basic_types.proto";
 import "timestamp.proto";
 import "consensus_submit_message.proto";
 
 message ConsensusTopicQuery {
-    .proto.TopicID topicID = 1; // A required topic ID to retrieve messages for.
+    /**
+     * A required topic ID to retrieve messages for.
+     */
+    .proto.TopicID topicID = 1;
 
-    // Include messages which reached consensus on or after this time. Defaults to current time if not set.
+    /**
+     * Include messages which reached consensus on or after this time. Defaults to current time if
+     * not set.
+     */
     .proto.Timestamp consensusStartTime = 2;
 
-    // Include messages which reached consensus before this time. If not set it will receive indefinitely.
+    /**
+     * Include messages which reached consensus before this time. If not set it will receive
+     * indefinitely.
+     */
     .proto.Timestamp consensusEndTime = 3;
 
-    // The maximum number of messages to receive before stopping. If not set or set to zero it will return messages
-    // indefinitely.
+    /**
+     * The maximum number of messages to receive before stopping. If not set or set to zero it will
+     * return messages indefinitely.
+     */
     uint64 limit = 4;
 }
 
 message ConsensusTopicResponse {
-    .proto.Timestamp consensusTimestamp = 1; // The time at which the transaction reached consensus
+    /**
+     * The time at which the transaction reached consensus
+     */
+    .proto.Timestamp consensusTimestamp = 1;
 
-    // The message body originally in the ConsensusSubmitMessageTransactionBody. Message size will be less than 6KiB.
+    /**
+     * The message body originally in the ConsensusSubmitMessageTransactionBody. Message size will
+     * be less than 6KiB.
+     */
     bytes message = 2;
 
-    bytes runningHash = 3; // The running hash (SHA384) of every message.
+    /**
+     * The running hash (SHA384) of every message.
+     */
+    bytes runningHash = 3;
 
-    uint64 sequenceNumber = 4; // Starts at 1 for first submitted message. Incremented on each submitted message.
+    /**
+     * Starts at 1 for first submitted message. Incremented on each submitted message.
+     */
+    uint64 sequenceNumber = 4;
 
-    uint64 runningHashVersion = 5; // Version of the SHA-384 digest used to update the running hash.
+    /**
+     * Version of the SHA-384 digest used to update the running hash.
+     */
+    uint64 runningHashVersion = 5;
 
-    .proto.ConsensusMessageChunkInfo chunkInfo = 6; // Optional information of the current chunk in a fragmented message.
+    /**
+     * Optional information of the current chunk in a fragmented message.
+     */
+    .proto.ConsensusMessageChunkInfo chunkInfo = 6;
 }
 
-//
-// The Mirror Service provides the ability to query a stream of Hedera Consensus Service (HCS) messages for an
-// HCS Topic via a specific (possibly open-ended) time range.
-//
+/**
+ * The Mirror Service provides the ability to query a stream of Hedera Consensus Service (HCS)
+ * messages for an HCS Topic via a specific (possibly open-ended) time range.
+ */
 service ConsensusService {
     rpc subscribeTopic (ConsensusTopicQuery) returns (stream ConsensusTopicResponse);
 }