mirror_ifupdown2/docs/source/apiref.rst
Roopa Prabhu 2c0ad8b338 Doc updates + cleanup
Ticket: CM-2297
Reviewed By:
Testing Done: compile tested

more updates coming ...
2014-07-17 11:44:36 -07:00

69 lines
1.5 KiB
ReStructuredText

Documentation for the Code
**************************
ifupdownmain -- explicit members
================================
ifupdownmain is the main ifupdown module.
.. automodule:: ifupdownmain
.. autoclass:: ifupdownMain
:members: up, down, reload, query
iface -- explicit members
=========================
iface is the class that represents an ifupdown iface object.
.. automodule:: iface
.. autoclass:: iface
:members: state, status, flags, priv_flags, refcnt, lowerifaces, upperifaces, add_to_upperifaces, get_attr_value, get_attr_value_first, get_attr_value_n, update_config, update_config_with_status, get_config_attr_status, compare, dump_raw, dump, dump_pretty
.. autoclass:: ifaceState
.. autoclass:: ifaceStatus
.. autoclass:: ifaceJsonEncoder
scheduler -- explicit members
=============================
.. automodule:: scheduler
.. autoclass:: ifaceScheduler
:members: sched_ifaces
.. autoclass:: ifaceSchedulerFlags
networkinterfaces -- explicit members
=====================================
.. automodule:: networkinterfaces
.. autoclass:: networkInterfaces
:members: load, subscribe
statemanager -- explicit members
================================
.. automodule:: statemanager
.. autoclass:: pickling
:members: save, save_obj, load
.. autoclass:: stateManager
:members: read_saved_state, save_state
graph -- explicit members
=========================
.. automodule:: graph
.. autoclass:: graph
:members: topological_sort_graphs_all, generate_dots