ApirefMarkdownGenerator - janklab.mlxshake.internal
HandleCompatible
janklab.mlxshake.internal.ApirefMarkdownGenerator
janklab.mlxshake.internal.ApirefGenerator
janklab.mlxshake.internal.MlxshakeBaseHandle
handle
Helptext
Generates Markdown format output for API Reference doco.
Class Contents
Properties
| Property | Description |
|---|---|
| stuffDir | |
| pkgsDir | |
| thingsDir | |
| pkgInfo | |
| uPackages | |
| pkgRelMdFiles | |
| thingRelMdFiles |
Methods
| Method | Description |
|---|---|
| generateClassDoc | Generate doco file for a class. |
| generateFunctionDoc | Generate doco file for a function. |
| generatePackageDoc | Generate doco files for a package. |
| generateIndex | Generate the main index files for the full code base. |
| thingHtmlFileRelPath | janklab.mlxshake.internal.ApirefMarkdownGenerator/thingHtmlFileRelPath is a function. |
| formatHelptext | |
| generateForMyFormat | Format-specific generation implementation. |
| ApirefMarkdownGenerator | Constructor. |
Superclasses
| Superclass | Description |
|---|---|
janklab.mlxshake.internal.ApirefGenerator |
Properties
stuffDir
Helptext:
No helptext available.
pkgsDir
Helptext:
No helptext available.
thingsDir
Helptext:
No helptext available.
pkgInfo
Helptext:
No helptext available.
uPackages
Helptext:
No helptext available.
pkgRelMdFiles
Attributes: HasDefault
Default Value: strings(0,0)
Helptext:
No helptext available.
thingRelMdFiles
Attributes: HasDefault
Default Value: strings(0,0)
Helptext:
No helptext available.
Methods
generateClassDoc
Signature:
generateClassDoc(this, rec)
Helptext:
Generate doco file for a class.
generateFunctionDoc
Signature:
generateFunctionDoc(this, pkg, name, qname, mFilePath)
Helptext:
Generate doco file for a function.
generatePackageDoc
Signature:
generatePackageDoc(this, rec)
Helptext:
Generate doco files for a package.
This does the package-level stuff only; not the functions and classes contained within it.
generateIndex
Signature:
generateIndex(this)
Helptext:
Generate the main index files for the full code base.
thingHtmlFileRelPath
Signature:
out = thingHtmlFileRelPath(this, thing)
Helptext:
janklab.mlxshake.internal.ApirefMarkdownGenerator/thingHtmlFileRelPath is a function. out = thingHtmlFileRelPath(this, thing)
formatHelptext
Signature:
out = formatHelptext(varargin)
Helptext:
helptextStr is the raw helptext. Will still have leading spaces and whatnot.
generateForMyFormat
Signature:
generateForMyFormat(this)
Helptext:
Format-specific generation implementation.
Generates:
- index.md
- stuff/
.md for each package - stuff/
.md for each class or function
ApirefMarkdownGenerator
Signature:
obj = ApirefMarkdownGenerator()
Helptext:
Generates Markdown format output for API Reference doco.