| Extracted from Pike v7.8 release 866 at 2018-07-18.

[Top]
Tools
Tools.AutoDoc
Tools.AutoDoc.ProcessXML

# Method Tools.AutoDoc.ProcessXML.extractXML()

Method extractXML

  `string extractXML(string filename, int|void pikeMode, string|void type, string|void name, array(string)|void parentModules)`

Description

  This function extracts documentation from a file. The parameters type , name , and parentModules are used only when pikeMode != 0 and no C-style doc comments are present.

Parameter `filename`

  The file to extract from.

Parameter `pikeMode`

  Non-zero if it is a Pike file. If the file contains style doc comments, C-mode is used despite pikeMode != 0.

Parameter `type`

  `"class"`, `"module"` or `"namespace"`.

Parameter `name`

  The name of the class/module/namespace.

Parameter `parentModules`

  The ancestors of the class/module/namespace.

Example

      // To extract doc for Foo.Bar.Ippa:
         string xml = extractXML("lib/modules/Foo.pmod/Bar.pmod/Ippa.pike", 1,
           "class", "Ippa", ({ "Foo", "Bar" }));