Pike v8.1 release 6

Method Tools.AutoDoc.ProcessXML.mergeTrees()


Method mergeTrees

void mergeTrees(SimpleNode dest, SimpleNode source)

Description

Puts all children of source into the tree dest, in their correct place module-hierarchically.

Used to merge the results of extractions of different Pike and C files.

Some minor effort is expended to normalize the result to some sort of canonical order.

Parameter source
Parameter dest

The nodes source and dest are <class>, <module>, <namespace> or <autodoc> nodes that are identical in the sense that they represent the same module, class or namespace. Typically they both represent <autodoc> nodes.

Note

Both source and dest are modified destructively.

Note

After calling this method, any <class> or <module> nodes that have been marked with @appears or @belongs, are still in the wrong place in the tree, so handleAppears() (or postProcess()) must be called on the whole documentation tree to relocate them once the tree has been fully merged.