Merge pull request #209 from ansys/LGP/25R2/25R2-mc-java-api

updated formatting. Rearranged toc. Renamed index-all to reference-all.

Author: AnsMelanie

2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXAnalysis.md

@@ -31,7 +31,7 @@ If you also want to support Athena, you should extend `IPHXAthenaAnalysis` inste
 ### execute
 ```java
 void execute()
-    throws java.lang.Exception
+      throws java.lang.Exception
 ```
 Executes the analysis. If the analysis does not run successfully, e.g. the solution does not converge, then an exception should be thrown.
 

2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXComponent.md

@@ -40,7 +40,7 @@ The above functions are used by the "describe" command in ModelCenter Remote Exe
 ### end
 ```java
 void end()
-    throws java.lang.Exception
+         throws java.lang.Exception
 ```
 Notifies the driver that it has ended. The driver should perform any necessary shutdown functions.
 

2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXDriver.md

@@ -32,7 +32,7 @@ This is the interface that drivers managed by ModelCenter Remote Execution must
 ### initializeIterations
 ```java
 void initializeIterations()
-    throws java.lang.Exception
+                   throws java.lang.Exception
 ```
 Initializes the driver to a starting state. This function will be called once before a series of step() calls will be made. The function should reset things like iteration counts to initial values.
 
@@ -42,7 +42,7 @@ Initializes the driver to a starting state. This function will be called once be
 ### startIteration
 ```java
 void startIteration()
-    throws java.lang.Exception
+             throws java.lang.Exception
 ```
 Performs the first step for an iteration of a driver. The driver should set values for all output reference variables. The client application will load these values and compute new values for the input references.
 
@@ -52,7 +52,7 @@ Performs the first step for an iteration of a driver. The driver should set valu
 ### endIteration
 ```java
 boolean endIteration()
-    throws java.lang.Exception
+              throws java.lang.Exception
 ```
 Performs the second step for an iteration of a driver. Prior to calling this function, the client application will have set values for all input reference variables. The driver should use these values to determine the next iteration, if any.
 

2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXHaltableComponent.md

@@ -23,7 +23,7 @@ This is a specialized interface for ModelCenter Remote Execution. If a component
 ### halt
 ```java
 void halt()
-    throws java.lang.Exception
+   throws java.lang.Exception
 ```
 Notifies the component to stop doing whatever it is currently doing.
 

2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXMonitorable.md

@@ -28,7 +28,7 @@ This is the interface that analyses which provide information about running proc
 ### listProcesses
 ```java
 PHXProcessInfo[] listProcesses()
-    throws java.io.IOException
+                        throws java.io.IOException
 ```
 Lists all the running processes associated with a component.
 
@@ -38,7 +38,7 @@ Lists all the running processes associated with a component.
 ### listMonitorableFiles
 ```java
 java.lang.String[] listMonitorableFiles()
-    throws java.io.IOException
+                                 throws java.io.IOException
 ```
 Lists all items that may be monitored for output as a component is running. Note that this is normally in addition to any PHXRawFile output variables that your component exposes. Because of this, these names must not conflict with any variable names.
 
@@ -48,7 +48,7 @@ Lists all items that may be monitored for output as a component is running. Note
 ### getMonitor
 ```java
 java.lang.Object getMonitor(java.lang.String monitorName)
-    throws PHXNoSuchObjectException
+                     throws PHXNoSuchObjectException
 ```
 Gets a specified monitor. This method can return PHXRawFile objects to publish files for monitoring that don't appear as a regular variable, or PHXMonitorableStream objects to publish random streams of monitor data.
 

2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXRunQueue.md

@@ -17,8 +17,9 @@ public interface IPHXRunQueue
 
 ### setRunQueue
 ```java
-void setRunQueue(java.lang.String connector, java.lang.String queue)
-    throws java.lang.Exception
+void setRunQueue(java.lang.String connector, 
+                 java.lang.String queue)
+          throws java.lang.Exception
 ```
 Sets the run queue for a component. It is important that this class throws [PHXNoSuchCategoryException](library/PHXNoSuchCategoryException.md) and [ClassNotFoundException](../util/PHXClassNotFoundException.md) in the appropriate cases as they are handled in special ways by the [PHXLibrarianMounter](library/PHXLibrarianMounter.md) and [PHXLibrarianCombiner](library/PHXLibrarianCombiner.md).
 

2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager.md

@@ -33,7 +33,8 @@ This interface is for components that determine their properties at runtime. The
 ### getValue
 ```java
 java.lang.String getValue(java.lang.String name)
-    throws PHXNoSuchObjectException, java.lang.Exception
+                   throws PHXNoSuchObjectException, 
+                          java.lang.Exception
 ```
 Function for retrieving a specified value.
 
@@ -49,8 +50,11 @@ Function for retrieving a specified value.
 
 ### setValue
 ```java
-void setValue(java.lang.String name, java.lang.String value)
-    throws PHXNoSuchObjectException, PHXNoSuchWriteableObjectException, java.lang.Exception
+void setValue(java.lang.String name, 
+              java.lang.String value)
+       throws PHXNoSuchObjectException, 
+              PHXNoSuchWriteableObjectException, 
+              java.lang.Exception
 ```
 Function for setting a specified value.
 
@@ -66,7 +70,8 @@ Function for setting a specified value.
 ### getPropertyDescriptors
 ```java
 PHXPropertyDescriptor[] getPropertyDescriptors(java.lang.String name)
-    throws PHXNoSuchObjectException, java.lang.Exception
+                                        throws PHXNoSuchObjectException, 
+                                               java.lang.Exception
 ```
 Function for retrieving the properties of an object.
 
@@ -96,7 +101,7 @@ Function for retrieving the methods of an object.
 ### invoke
 ```java
 java.lang.String invoke(java.lang.String methodName)
-    throws java.lang.Exception
+                 throws java.lang.Exception
 ```
 Invokes the named method.
 

2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager2.md

@@ -37,7 +37,8 @@ This interface extends [`IPHXSelfManager`](IPHXSelfManager.md) and provides new
 ### getValue2
 ```java
 java.lang.Object getValue2(java.lang.String name)
-    throws PHXNoSuchObjectException, java.lang.Exception
+                    throws PHXNoSuchObjectException, 
+                           java.lang.Exception
 ```
 Function for retrieving a specified value.
 
@@ -48,13 +49,16 @@ Function for retrieving a specified value.
 - The value to be returned as any type of java Object.
 
 **Throws:**
-- `PHXNoSuchObjectException` - thrown if the specified name does not exist
+- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) - thrown if the specified name does not exist
 - `java.lang.Exception` - an exception that may occur
 
 ### setValue2
 ```java
-void setValue2(java.lang.String name, PHXStringBuffer value)
-    throws PHXNoSuchObjectException, PHXNoSuchWriteableObjectException, java.lang.Exception
+void setValue2(java.lang.String name, 
+               PHXStringBuffer value)
+        throws PHXNoSuchObjectException, 
+               PHXNoSuchWriteableObjectException, 
+               java.lang.Exception
 ```
 Function for setting a specified value.
 
@@ -63,6 +67,6 @@ Function for setting a specified value.
 - `value` - the String representation of the value to set
 
 **Throws:**
-- `PHXNoSuchObjectException` - thrown if the specified name does not exist
-- `PHXNoSuchWriteableObjectException` - thrown if the specified name cannot be modified
+- [`PHXNoSuchObjectException`](PHXNoSuchObjectException.md) - thrown if the specified name does not exist
+- [`PHXNoSuchWriteableObjectException`](PHXNoSuchWriteableObjectException.md) - thrown if the specified name cannot be modified
 - `java.lang.Exception` - an exception that may occur

2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSelfManager3.md

@@ -36,7 +36,7 @@ This interface extends [`IPHXSelfManager2`](IPHXSelfManager2.md) and provides a
 ### invoke2
 ```java
 PHXInvokeReturn invoke2(java.lang.String methodName)
-    throws java.lang.Exception
+                 throws java.lang.Exception
 ```
 Invokes the named method.
 

2025R2/modelCenter_java_api/com/phoenix_int/aserver/IPHXSetupFromFile.md

@@ -26,7 +26,7 @@ This interface defines the contract for components that can be set up or initial
 ## Method Detail
 
 ### setupFromFile
-```
+```java
 public void setupFromFile(java.lang.String fileName)
                    throws java.io.IOException
 ```