Class ::acs::DocHelper

::acs::DocHelper[i] create ...

Helper class to determine the sourcefile, where some "public", "private", or plain "methods" is defined. The mixin is just active during initial bootstrap of the server. The definition assumes, that all definitions for a class are from the same file.
Defined in packages/acs-bootstrap-installer/tcl/00-proc-procs.tcl

Class Relations

  • class: ::nx::Class[i]
  • superclass: ::nx::Object[i]
  • mixinof: ::xowiki::formfield::page::slot::entry_label[i]
::nx::Class create ::acs::DocHelper \
     -superclass ::nx::Object

Methods (to be applied on instances)

  • method (scripted, public)

     <instance of acs::DocHelper[i]> method args [ args... ]

    Intercept "method" definitions to record the current filename for the API browser.

    Parameters:
    args (required)

    Testcases:
    No testcase defined.
    :register_filename
    return [next]
  • protected (scripted, public)

     <instance of acs::DocHelper[i]> protected what name args \
        [ args... ]

    Intercept "protected method" definitions to record the current filename for the API browser.

    Parameters:
    what (required)
    name (required)
    args (required)

    Testcases:
    No testcase defined.
    :register_filename
    return [next]
  • public (scripted, public)

     <instance of acs::DocHelper[i]> public what name args [ args... ]

    Intercept "public method" definitions to record the current filename for the API browser.

    Parameters:
    what (required)
    name (required)
    args (required)

    Testcases:
    No testcase defined.
    :register_filename
    return [next]