Update JSDocs and Javadocs

Author: rcosta358

client/src/extension.ts

@@ -25,7 +25,7 @@ let currentStateMachine: StateMachine | undefined;
 
 /**
  * Activates the LiquidJava extension
- * @param context
+ * @param context The extension context
  */
 export async function activate(context: vscode.ExtensionContext) {
     initLogging(context);
@@ -68,7 +68,7 @@ export async function deactivate() {
 
 /**
  * Initializes logging for the extension with an output channel
- * @param context
+ * @param context The extension context
  */
 function initLogging(context: vscode.ExtensionContext) {
     outputChannel = vscode.window.createOutputChannel("LiquidJava");
@@ -80,7 +80,7 @@ function initLogging(context: vscode.ExtensionContext) {
 
 /**
  * Initializes the status bar for the extension
- * @param context
+ * @param context The extension context
  */
 function initStatusBar(context: vscode.ExtensionContext) {
     statusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left);
@@ -93,7 +93,7 @@ function initStatusBar(context: vscode.ExtensionContext) {
 
 /**
  * Initializes the command palette for the extension
- * @param context
+ * @param context The extension context
  */
 function initCommandPalette(context: vscode.ExtensionContext) {
     context.subscriptions.push(
@@ -112,7 +112,7 @@ function initCommandPalette(context: vscode.ExtensionContext) {
 
 /**
  * Initializes the webview panel for the extension
- * @param context
+ * @param context The extension context
  */
 function initWebview(context: vscode.ExtensionContext) {
     webviewProvider = new LiquidJavaWebviewProvider(context.extensionUri);
@@ -166,7 +166,7 @@ function initHover() {
 
 /**
  * Initializes file system event listeners
- * @param context
+ * @param context The extension context
  */
 function initFileEvents(context: vscode.ExtensionContext) {
     // listen for active text editor changes
@@ -183,6 +183,10 @@ function initFileEvents(context: vscode.ExtensionContext) {
     );
 }
 
+/**
+ * Requests the state machine for the given document from the language server
+ * @param document The text document
+ */
 async function requestStateMachine(document: vscode.TextDocument) {
     const sm: StateMachine = await client?.sendRequest("liquidjava/fsm", { uri: document.uri.toString() });
     webviewProvider?.sendMessage({ type: "fsm", sm });
@@ -191,7 +195,7 @@ async function requestStateMachine(document: vscode.TextDocument) {
 
 /**
  * Updates the status bar with the current state
- * @param state
+ * @param state The current state ("loading", "stopped", "passed", "failed")
  */
 function updateStatusBar(state: "loading" | "stopped" | "passed" | "failed") {
     const icons = {
@@ -207,8 +211,8 @@ function updateStatusBar(state: "loading" | "stopped" | "passed" | "failed") {
 
 /**
  * Runs the LiquidJava language server
- * @param context
- * @param javaExecutablePath
+ * @param context The extension context
+ * @param javaExecutablePath The path to the Java executable
  * @returns A promise to the port number the server is running on
  */
 async function runLanguageServer(context: vscode.ExtensionContext, javaExecutablePath: string): Promise<number> {
@@ -247,8 +251,8 @@ async function runLanguageServer(context: vscode.ExtensionContext, javaExecutabl
 
 /**
  * Starts the client and connects it to the language server
- * @param context
- * @param port
+ * @param context The extension context
+ * @param port The port number the server is running on
  */
 async function runClient(context: vscode.ExtensionContext, port: number) {
     const serverOptions: ServerOptions = () => {
@@ -310,7 +314,7 @@ async function runClient(context: vscode.ExtensionContext, port: number) {
 
 /**
  * Stops the LiquidJava extension
- * @param reason
+ * @param reason The reason for stopping the extension
  */
 async function stopExtension(reason: string) {
     if (!client && !serverProcess && !socket) {
@@ -345,7 +349,7 @@ async function stopExtension(reason: string) {
 
 /**
  * Handles LiquidJava diagnostics received from the language server
- * @param diagnostics
+ * @param diagnostics The array of diagnostics received
  */
 function handleLJDiagnostics(diagnostics: LJDiagnostic[]) {
     const containsError = diagnostics.some(d => d.category === "error");
@@ -360,7 +364,7 @@ function handleLJDiagnostics(diagnostics: LJDiagnostic[]) {
 
 /**
  * Handles active file change events
- * @param editor 
+ * @param editor The active text editor
  */
 function handleActiveFileChange(editor: vscode.TextEditor) {
     currentFile = editor.document.uri.fsPath;

server/src/main/java/fsm/StateMachineParser.java

@@ -24,7 +24,7 @@ public class StateMachineParser {
 
     /**
      * Parses a class or interface for the given uri and extracts the state machine information
-     * @param uri
+     * @param uri the document URI
      * @return StateMachine or null if none found
      */
     public static StateMachine parse(String uri) {
@@ -75,7 +75,7 @@ public static StateMachine parse(String uri) {
 
     /**
      * Finds the first class or interface in the model (we assume only one per file)
-     * @param model
+     * @param model the CtModel
      * @return CtType or null if none found
      */
     private static CtType<?> getType(CtModel model) {
@@ -90,7 +90,7 @@ private static CtType<?> getType(CtModel model) {
     /**
      * Gets the simple name from a class or interface
      * Uses name from ExternalRefinementsFor if present, otherwise uses class or interface name
-     * @param ctType
+     * @param ctType the CtType (class or interface)
      * @return class name
      */
     private static String getClassName(CtType<?> ctType) {
@@ -105,7 +105,7 @@ private static String getClassName(CtType<?> ctType) {
 
     /**
      * Gets the possible states from a class or interface
-     * @param ctType
+     * @param ctType the CtType (class or interface)
      * @return list of states
      */
     private static List<String> getStates(CtType<?> ctType) {
@@ -121,7 +121,8 @@ private static List<String> getStates(CtType<?> ctType) {
     /**
      * Gets the initial state from a class
      * If not explicitely defined, uses the first state in the state set
-     * @param ctClass
+     * @param ctClass the CtClass
+     * @param states the list of states
      * @return initial state
      */
     private static String getInitialStateFromClass(CtClass<?> ctClass, List<String> states) {
@@ -142,8 +143,8 @@ private static String getInitialStateFromClass(CtClass<?> ctClass, List<String>
     /**
      * Gets the initial state from an interface
      * If not explicitely defined, uses the first state in the state set
-     * @param ctInterface
-     * @param className
+     * @param ctInterface the CtInterface
+     * @param className the class name
      * @return initial state
      */
     private static String getInitialStateFromInterface(CtInterface<?> ctInterface, String className, List<String> states) {
@@ -165,8 +166,8 @@ private static String getInitialStateFromInterface(CtInterface<?> ctInterface, S
 
     /**
      * Gets transitions from a class
-     * @param ctClass
-     * @param states
+     * @param ctClass the CtClass
+     * @param states the list of states
      * @return list of StateMachineTransition
      */
     private static List<StateMachineTransition> getTransitionsFromClass(CtClass<?> ctClass, List<String> states) {
@@ -185,9 +186,9 @@ private static List<StateMachineTransition> getTransitionsFromClass(CtClass<?> c
 
     /**
      * Gets transitions from an interface
-     * @param ctInterface
-     * @param className
-     * @param states
+     * @param ctInterface the CtInterface
+     * @param className the class name
+     * @param states the list of states
      * @return list of StateMachineTransition
      */
     private static List<StateMachineTransition> getTransitionsFromInterface(CtInterface<?> ctInterface, String className, List<String> states) {
@@ -207,9 +208,9 @@ private static List<StateMachineTransition> getTransitionsFromInterface(CtInterf
 
     /**
      * Gets transitions from the given annotation
-     * @param ann
-     * @param method
-     * @param states
+     * @param ann the CtAnnotation
+     * @param method the method name
+     * @param states the list of states
      * @return list of StateMachineTransition
      */
     private static List<StateMachineTransition> getTransitions(CtAnnotation<?> ann, String method, List<String> states) {
@@ -242,8 +243,8 @@ private static List<StateMachineTransition> getTransitions(CtAnnotation<?> ann,
 
     /**
      * Parses a state expression and returns the list of states
-     * @param expr
-     * @param states
+     * @param expr the expression
+     * @param states the list of possible states
      * @return list of states
      */
     private static List<String> parseStateExpression(String expr, List<String> states) {
@@ -254,8 +255,8 @@ private static List<String> parseStateExpression(String expr, List<String> state
 
     /**
      * Gets state names from an expression AST recursively
-     * @param expr
-     * @param states
+     * @param expr the expression
+     * @param states the list of possible states
      * @return list of states
      */
     private static List<String> getStateExpressions(Expression expr, List<String> states) {