gobj_build_cmds_doc()

`gobj_build_cmds_doc()`#

gobj_build_cmds_doc() generates a JSON-formatted documentation of available commands for a given hgobj.

C

Prototype

json_t *gobj_build_cmds_doc(
    hgobj   gobj,
    json_t *kw
);

Parameters

Key	Type	Description
`gobj`	`hgobj`	The `hgobj` instance whose commands are to be documented.
`kw`	`json_t *`	A JSON object containing optional parameters such as `level` (integer) to control the depth of command retrieval and `cmd` (string) to filter a specific command.

Return Value

A JSON string containing the formatted documentation of available commands. If a specific command is requested and found, its detailed documentation is returned. If the command is not found, an error message is returned.

Notes

If level is set, gobj_build_cmds_doc() will also include commands from child objects of the given hgobj.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python

gobj_build_cmds_doc()

gobj_build_cmds_doc()#

`gobj_build_cmds_doc()`#