ArgumentsToHtml(fn, isMethod = false) : String
Returns HTML documentation of function arguments.
ArgumentsToHtml Parameters
fn : Function
isMethod : Boolean = false
True to skip 1st argument.
ArgumentToString(arg) : String
Returns short string documentation of Argument.
ArgumentToString Parameters
arg : Argument
ArgumentTypeToString(argType) : String
Returns HTML documentation of ArgumentType.
ArgumentTypeToString Parameters
argType : ArgumentType?
DescriptionToHtml(descr) : String
Converts description string to HTML.
For example, new lines are converted to HTML line break tags.
DescriptionToHtml Parameters
descr : String?
ExampleToHtml(example) : String
Wraps code example to HTML code block.
ExampleToHtml Parameters
example : String
GenActionViewsDocs(view, level = 2) : String
Generates HTML documentation for an Action and ItemAction view.
GenActionViewsDocs Parameters
view : View
Target view to generate documentation for.
level : Integer = 2
Level used for header (2 means h2).
GenFunctionDocs(fn, level = 2, isMethod = false) : String
Generates HTML documentation for a Function.
GenFunctionDocs Parameters
fn : Function
Target function to generate documentation for.
level : Integer = 2
Level used for header (2 means h2).
isMethod : Boolean = false
True to generate method documentation.
GenTaskCommandDocs(cmd, level = 2) : String
Generates HTML documentation for a Task Command.
GenTaskCommandDocs Parameters
cmd : ?
Target command to generate documentation for.
level : Integer = 2
Level used for header (2 means h2).
GenTypeDocs(type, level = 2) : String
Generates HTML documentation for a Gnosis Script Object.
GenTypeDocs Parameters
type : ?
Target type to generate documentation for.
level : Integer = 2
Level used for header (2 means h2).
GenViewDocs(view, level = 2, skipMethod = false) : String
Generates HTML documentation for a View.
GenViewDocs Parameters
view : View
Target view to generate documentation for.
level : Integer = 2
Level used for header (2 means h2).
skipMethod : Boolean = false
True to skip method prefix in view name.
ParamToString(arg, skipDef = false) : String
Returns HTML documentation of Argument param.
ParamToString Parameters
arg : Argument?
skipDef : Boolean = false
True to skip default value.
WpCreatePost(params) : String
Creates a WordPress Post.
WpCreatePost Parameters
params : Dict
The Post content.
WpCreatePost Examples
CreateWpPost({ content = 'Some test string' });WpDeletePosts(tag?)
Deletes ALL WordPress Posts.
WpDeletePosts Parameters
tag? : String
Tag to delete posts by tag.
WpGetCategory(name, slug?, create = false) : Dict
Search WordPress Category by its name (slug).
WpGetCategory Parameters
name : String
slug? : String?
create : Boolean = false
True to create if not found.
WpGetTag(name, slug?, create = false) : Dict
Search WordPress Tag by its name (slug).
WpGetTag Parameters
name : String
slug? : ?
create : Boolean = false
True to create if not found.
