convert comments to document (#214)

addons/com.heroiclabs.nakama/Nakama.gd

@@ -1,22 +1,22 @@
 @tool
 extends Node
 
-# The default host address of the server.
+## The default host address of the server.
 const DEFAULT_HOST : String = "127.0.0.1"
 
-# The default port number of the server.
+## The default port number of the server.
 const DEFAULT_PORT : int = 7350
 
-# The default timeout for the connections.
+## The default timeout for the connections.
 const DEFAULT_TIMEOUT = 3
 
-# The default protocol scheme for the client connection.
+## The default protocol scheme for the client connection.
 const DEFAULT_CLIENT_SCHEME : String = "http"
 
-# The default protocol scheme for the socket connection.
+## The default protocol scheme for the socket connection.
 const DEFAULT_SOCKET_SCHEME : String = "ws"
 
-# The default log level for the Nakama logger.
+## The default log level for the Nakama logger.
 const DEFAULT_LOG_LEVEL = NakamaLogger.LOG_LEVEL.DEBUG
 
 var _http_adapter = null

addons/com.heroiclabs.nakama/Satori.gd

@@ -1,19 +1,19 @@
 @tool
 extends Node
 
-# The default host address of the server.
+## The default host address of the server.
 const DEFAULT_HOST : String = "127.0.0.1"
 
-# The default port number of the server.
+## The default port number of the server.
 const DEFAULT_PORT : int = 7450
 
-# The default timeout for the connections.
+## The default timeout for the connections.
 const DEFAULT_TIMEOUT = 15
 
-# The default protocol scheme for the client connection.
+## The default protocol scheme for the client connection.
 const DEFAULT_CLIENT_SCHEME : String = "http"
 
-# The default log level for the Satori logger.
+## The default log level for the Satori logger.
 const DEFAULT_LOG_LEVEL = SatoriLogger.LOG_LEVEL.DEBUG
 
 var _http_adapter = null

addons/com.heroiclabs.nakama/Satori/Event.gd

@@ -2,30 +2,29 @@ extends SatoriAsyncResult
 
 class_name Event
 
-# The name of the event.
+## The name of the event.
 var name: String
 
-# The time when the event was triggered.
+## The time when the event was triggered.
 var timestamp: String
 
-# Optional value.
+## Optional value.
 var value: String
 
-# Event metadata, if any.
+## Event metadata, if any.
 var metadata: Dictionary
 
-# Optional event ID assigned by the client, used to de-duplicate in retransmission scenarios.
-# If not supplied the server will assign a randomly generated unique event identifier.
+## Optional event ID assigned by the client, used to de-duplicate in retransmission scenarios. [br]
+## If not supplied the server will assign a randomly generated unique event identifier.
 var id: String
 
-# The event constructor.
- # Initializes a new Event object.
- #
- # @param name The name of the event.
- # @param timestamp The timestamp of the event.
- # @param value The value associated with the event (optional).
- # @param metadata The metadata associated with the event (optional).
- # @param id The ID of the event (optional).
+## The event constructor. [br]
+## Initializes a new Event object. [br]
+## name The name of the event. [br]
+## timestamp The timestamp of the event. [br]
+## value The value associated with the event (optional). [br]
+## metadata The metadata associated with the event (optional). [br]
+## id The ID of the event (optional). [br]
 func _init(name: String, timestamp: float, value: String = "", metadata: Dictionary = {}, id: String = "", p_exception = null):
 	super(p_exception)
 
@@ -62,4 +61,4 @@ func unix_to_protobuf_timestamp_format(unix_time: float) -> String:
 	# Construct the protobuf timestamp format string
 	var timestamp_str = "%s-%s-%sT%s:%s:%s.%sZ" % [year, month, day, hour, minute, second, microsecond]
 
-	return timestamp_str
+	return timestamp_str