Skip to the content.

ApirefGenerator - janklab.mlxshake.internal

Abstract, HandleCompatible

janklab.mlxshake.internal.ApirefGenerator
  janklab.mlxshake.internal.MlxshakeBaseHandle
    handle

Helptext

Generates API Reference doco from source code.

Class Contents

Properties

Property Description
outDir  
inDirs  
opts  
mfiles  
packages  

Methods

Method Description
generateForMyFormat Generate the output in the subclass’s output format.
forFormat  
discover Discover source code files on the input paths.
generate Generate the doco output.
ApirefGenerator Constructor.

Superclasses

Superclass Description
janklab.mlxshake.internal.MlxshakeBaseHandle  

Properties

outDir

Helptext:

No helptext available.

inDirs

Helptext:

No helptext available.

opts

Helptext:

No helptext available.

mfiles

Helptext:

No helptext available.

packages

Helptext:

No helptext available.

Methods

generateForMyFormat

Attributes: Abstract

Signature:

generateForMyFormat(this)

Helptext:

Generate the output in the subclass’s output format.

forFormat

Attributes: Static

Signature:

out = ApirefGenerator.forFormat(varargin)

Helptext:

Construct an ApirefGenerator for a given format.

discover

Signature:

discover(this)

Helptext:

Discover source code files on the input paths.

generate

Signature:

generate(this)

Helptext:

Generate the doco output.

ApirefGenerator

Signature:

obj = ApirefGenerator()

Helptext:

Generates API Reference doco from source code.