gobj_build_cmds_doc()

Build documentation for all available commands in a GObj.

C

Prototype

PUBLIC json_t *gobj_build_cmds_doc(
    hgobj       gobj,
    const char *topic
);
        

Parameters

Key	Type	Description
gobj	hgobj	The GObj to retrieve command documentation from.
topic	const char *	The topic to filter commands by, or NULL for all commands.

---

Return Value

Returns a json_t * object containing the documentation for the commands, or NULL on failure.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python

Examples

C

// TODO C examples

JS

// TODO JS examples

Python

# TODO Python examples