Skip to main content

utility:html doc

Version: 0.0.0

Description​

Create dpf's html documentation. Only on Windows.

Inputs​

InputNameExpected type(s)Description
Pin 0output_pathstringdefault is {working directory}/dataProcessingDoc.html
Pin 1exposure_levelint32Generate the documentation depending on exposure level : 0 (default) for public operators, 1 includes hidden operator, 2 includes private operator, 3 includes operator without specifications.

Outputs​

OutputNameExpected type(s)Description

Configurations​

NameExpected type(s)Default valueDescription
mutexboolfalseIf this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

Scripting​

Category: utility

Plugin: documentation

Scripting name: None

Full name: None

Internal name: html_doc

License: None

Changelog​

  • Version 0.0.0: Initial release.