io.warp10.script.formatted

Class DocumentationGenerator

java.lang.Object

io.warp10.script.formatted.DocumentationGenerator

Deprecated.

@Deprecated
public class DocumentationGenerator
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DocumentationGenerator() Deprecated.

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.Object>	generateInfo(FormattedWarpScriptFunction function, java.util.List<ArgumentSpecification> outputs) Deprecated.
static java.util.Map<java.lang.String,java.lang.Object>	generateInfo(FormattedWarpScriptFunction function, java.lang.String since, java.lang.String deprecated, java.lang.String deleted, java.lang.String version, java.util.List<java.lang.String> tags, java.util.List<java.lang.String> related, java.util.List<java.lang.String> examples, java.util.List<java.lang.String> conf, java.util.List<ArgumentSpecification> outputs) Deprecated.
static java.lang.String	generateWarpScriptDoc(FormattedWarpScriptFunction function, java.util.List<ArgumentSpecification> outputs) Deprecated.
static java.lang.String	generateWarpScriptDoc(FormattedWarpScriptFunction function, java.lang.String since, java.lang.String deprecated, java.lang.String deleted, java.lang.String version, java.util.List<java.lang.String> tags, java.util.List<java.lang.String> related, java.util.List<java.lang.String> examples, java.util.List<java.lang.String> conf, java.util.List<ArgumentSpecification> outputs) Deprecated. Generate readable WarpScript .mc2 documentation file

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentationGenerator

public DocumentationGenerator()

Deprecated.

Method Detail

generateInfo

public static java.util.Map<java.lang.String,java.lang.Object> generateInfo(FormattedWarpScriptFunction function,
                                                                            java.util.List<ArgumentSpecification> outputs)

Deprecated.

generateInfo

public static java.util.Map<java.lang.String,java.lang.Object> generateInfo(FormattedWarpScriptFunction function,
                                                                            java.lang.String since,
                                                                            java.lang.String deprecated,
                                                                            java.lang.String deleted,
                                                                            java.lang.String version,
                                                                            java.util.List<java.lang.String> tags,
                                                                            java.util.List<java.lang.String> related,
                                                                            java.util.List<java.lang.String> examples,
                                                                            java.util.List<java.lang.String> conf,
                                                                            java.util.List<ArgumentSpecification> outputs)

Deprecated.

generateWarpScriptDoc

public static java.lang.String generateWarpScriptDoc(FormattedWarpScriptFunction function,
                                                     java.util.List<ArgumentSpecification> outputs)
                                              throws WarpScriptException

Deprecated.

Throws:

WarpScriptException

generateWarpScriptDoc

public static java.lang.String generateWarpScriptDoc(FormattedWarpScriptFunction function,
                                                     java.lang.String since,
                                                     java.lang.String deprecated,
                                                     java.lang.String deleted,
                                                     java.lang.String version,
                                                     java.util.List<java.lang.String> tags,
                                                     java.util.List<java.lang.String> related,
                                                     java.util.List<java.lang.String> examples,
                                                     java.util.List<java.lang.String> conf,
                                                     java.util.List<ArgumentSpecification> outputs)
                                              throws WarpScriptException

Deprecated.

Generate readable WarpScript .mc2 documentation file

Parameters:

function -

since -

deprecated -

deleted -

version -

tags -

related -

examples -

conf -

outputs -

Returns:

warpscript_code

Throws:

WarpScriptException