xo::api proc update_nx_docs (public)

 xo::api update_nx_docs [ objects ]

Defined in packages/xotcl-core/tcl/01-debug-procs.tcl

Refresh API Browser documentation for NX objects and classes.

Parameters:

objects (optional)

List of objects to document, or empty to scan all NX instances. Skip NX internals and slot containers.

Testcases:

xo_update_object_doc

Source code:

# Refresh API Browser documentation for NX objects and classes.
# @param objects List of objects to document, or empty to scan all
#     NX instances. Skip NX internals and slot containers.

if {[llength $objects] == 0} {
  set objects [nx::Object info instances -closure]
}

foreach o $objects {
  #
  # Check general per-object documentation.
  #
  if {[string match ::nx::* $o]
      || [string match *::slot::* $o]
      || [::nsf::object::property $o slotcontainer]} {
    continue
  }
  ::xo::api update_object_doc "" $o ""
}

XQL Not present:

Generic, PostgreSQL, Oracle