doc: server hello message

src/cli/repl/commands/version.ts

@@ -5,8 +5,13 @@ import { guard } from '../../../util/assert'
 
 type Version = `${number}.${number}.${number}`
 
+/**
+ * Describes the version of flowR and the used R interpreter.
+ */
 export interface VersionInformation {
+	/** The version of flowR */
 	flowr: Version,
+	/** The version of R identified by the underlying {@link RShell} */
 	r:     Version | 'unknown'
 }
 

src/cli/repl/server/messages/hello.ts

@@ -1,11 +1,22 @@
 import { VersionInformation } from '../../commands/version'
 import { FlowrBaseMessage } from './messages'
 
+/**
+ * The hello message is automatically send by the sever upon connection.
+ */
 export interface FlowrHelloResponseMessage extends FlowrBaseMessage {
 	type:       'hello',
+	/** The hello message never has an id, it is always undefined */
 	id:         undefined,
-	/** a unique name assigned to each client it has no semantic meaning and is only used for debugging */
+	/**
+	 * A unique name that is assigned to each client.
+	 * It has no semantic meaning and is only used/useful for debugging.
+	 */
 	clientName: string,
+	/**
+	 * Describes which versions are in use on the server.
+	 * @see VersionInformation
+	 */
 	versions:   VersionInformation
 }