docs(ts): Fix vtkAlgorithm type definition

Author: daker

Sources/interfaces.d.ts

@@ -1,4 +1,6 @@
 import vtkDataArray from "./Common/Core/DataArray";
+import vtkImageData from "./Common/DataModel/ImageData";
+import vtkPolyData from "./Common/DataModel/PolyData";
 import { vtkPipelineConnection } from "./types";
 
 /**
@@ -32,48 +34,88 @@ export interface vtkOutputPort {
  * vtkAlgorithm API
  */
 export interface vtkAlgorithm {
+
 	/**
-	 * @param dataset
-	 * @param port (default 0)
+	 * Assign a data object as input.
+	 * @param {vtkPolyData} dataset 
+	 * @param {Number} [port] The port number (default 0).
 	 */
-	setInputData(dataset: any, port?: number): void;
+	setInputData(dataset: vtkPolyData, port?: number): void;
+
 	/**
-	 * @param port (default 0)
+	 * @param {Number} [port] The port number (default 0).
 	 */
 	getInputData(port?: number): any;
+
 	/**
 	 * @param outputPort
-	 * @param port (default 0)
+	 * @param {Number} [port] The port number (default 0).
 	 */
 	setInputConnection(outputPort: vtkPipelineConnection, port?: number): void;
+
 	/**
-	 * @param port (default 0)
+	 * @param {Number} [port] The port number (default 0).
 	 */
 	getInputConnection(port?: number): vtkPipelineConnection;
+
+	/**
+	 * Add a connection to the given input port index.
+	 * @param {vtkPipelineConnection} outputPort 
+	 */
 	addInputConnection(outputPort: vtkPipelineConnection): void;
+
+	/**
+	 * 
+	 * @param dataset 
+	 */
 	addInputData(dataset: any): void;
+
 	/**
-	 * @param port (default 0)
+	 * Get the data object that will contain the algorithm output for the given
+	 * port.
+	 * @param {Number} [port] The port number (default 0).
+	 */
+	getOutputData(port?: number): vtkImageData | vtkPolyData;
+
+	/**
+	 * 
 	 */
-	getOutputData(port?: number): any;
 	shouldUpdate(): boolean;
+
 	/**
-	 * @param port (default 0)
+	 * Get a proxy object corresponding to the given output port of this
+	 * algorithm. 
+	 * @param {Number} [port] The port number (default 0).
 	 */
 	getOutputPort(port?: number): vtkPipelineConnection;
+
+	/**
+	 * Bring this algorithm's outputs up-to-date.
+	 */
 	update(): void;
+
+	/**
+	 * Get the number of input ports used by the algorithm.
+	 */
 	getNumberOfInputPorts(): number;
+
+	/**
+	 * Get the number of output ports provided by the algorithm.
+	 */
 	getNumberOfOutputPorts(): number;
+
 	/**
-	 * @param port (default 0)
+	 * Get the actual data array for the input array sepcified by idx.
+	 * @param {Number} port (default 0)
 	 */
 	getInputArrayToProcess(inputPort?: number): vtkDataArray;
+
 	/**
-	 *
-	 * @param inputPort
-	 * @param arrayName
-	 * @param fieldAssociation
-	 * @param attributeType (default 'Scalars')
+	 * Set the input data arrays that this algorithm will process. 
+	 * @param {Number} inputPort The port number.
+	 * @param {String} arrayName The name of the array.
+	 * @param {String} fieldAssociation The name of the association field.
+	 * @param {String} attributeType (default 'Scalars')
 	 */
 	setInputArrayToProcess(
 		inputPort: number,
@@ -87,9 +129,9 @@ export interface vtkAlgorithm {
 * Base vtkClass which provides MTime tracking and class infrastructure
 */
 export interface vtkObject {
+	
 	/**
 	 * Allow to check if that object was deleted (.delete() was called before).
-	 *
 	 * @returns true if delete() was previously called
 	 */
 	isDeleted(): boolean;
@@ -137,14 +179,14 @@ export interface vtkObject {
 	 * Generic method to set many fields at one.
 	 *
 	 * For example calling the following function
-	 * ```
+	 * ```js
 	 * changeDetected = sphereSourceInstance.set({
 	 *    phiResolution: 10,
 	 *    thetaResolution: 20,
 	 * });
 	 * ```
 	 * will be equivalent of calling
-	 * ```
+	 * ```js
 	 * changeDetected += sphereSourceInstance.setPhiResolution(10);
 	 * changeDetected += sphereSourceInstance.setThetaResolution(20);
 	 * changeDetected = !!changeDetected;
@@ -157,9 +199,9 @@ export interface vtkObject {
 	 * If `noFunction` is set to true, the field will be set directly on the model
 	 * without calling the `set${FieldName}()` method.
 	 *
-	 * @param map (default: {}) Object capturing the set of fieldNames and associated values to set.
-	 * @param noWarning (default: false) Boolean to disable any warning.
-	 * @param noFunctions (default: false) Boolean to skip any function execution and rely on only setting the fields on the model.
+	 * @param [map] (default: {}) Object capturing the set of fieldNames and associated values to set.
+	 * @param [noWarning] (default: false) Boolean to disable any warning.
+	 * @param [noFunctions] (default: false) Boolean to skip any function execution and rely on only setting the fields on the model.
 	 * @return true if a change was actually performed. False otherwise when the value provided were equal to the ones already set inside the instance.
 	 */
 	set(map?: object, noWarning?: boolean, noFunction?: boolean): boolean;
@@ -215,15 +257,15 @@ export interface vtkObject {
 	/**
 	 * Try to copy the state of the other to ourselves by just using references.
 	 *
-	 * @param other instance to copy the reference from
-	 * @param debug (default: false) if true feedback will be provided when mismatch happen
+	 * @param {vtkObject} other instance to copy the reference from
+	 * @param {Boolean} [debug] (default: false) if true feedback will be provided when mismatch happen
 	 */
 	shallowCopy(other: vtkObject, debug?: boolean): void;
 }
 
 export interface vtkProperty {
 	name: string;
-	children?: Array<vtkProperty>;
+	children?: vtkProperty[];
 }
 
 export interface vtkPropertyDomain {}