Topic api

Cleaner API

Functions

cleaner.get_replace_items () Retrieves list of items to be replaced.
cleaner.get_replace_nodes () Retrieves list of nodes to be replaced.
cleaner.remove_entity (src) Registers an entity to be removed.
cleaner.remove_node (src) Registers a node to be removed.
cleaner.replace_item (src, tgt) Registeres an item to be replaced.
cleaner.replace_node (src, tgt) Registers a node to be replaced.


Functions

cleaner.get_replace_items ()
Retrieves list of items to be replaced.

Returns:

    table Items to be replaced.
cleaner.get_replace_nodes ()
Retrieves list of nodes to be replaced.

Returns:

    table Nodes to be replaced.
cleaner.remove_entity (src)
Registers an entity to be removed.

Parameters:

  • src string Entity technical name.
cleaner.remove_node (src)
Registers a node to be removed.

Parameters:

  • src string Node technical name.
cleaner.replace_item (src, tgt)
Registeres an item to be replaced.

Parameters:

  • src string Technical name of item to be replaced.
  • tgt string Technical name of item to be used in place.
cleaner.replace_node (src, tgt)
Registers a node to be replaced.

Parameters:

  • src string Technical name of node to be replaced.
  • tgt string Technical name of node to be used in place.
generated by LDoc 1.4.6 Last updated 2021-07-12 08:57:46