diff --git a/doc/userdoc.org b/doc/userdoc.org index 5d189d77069459c6727645c9f08cd465da01c618..4b0123435640a6b9a430175a61f6356ad3f26249 100644 --- a/doc/userdoc.org +++ b/doc/userdoc.org @@ -2496,6 +2496,32 @@ But a file is created (in the execution directory), with the name #+RESULTS: cat-filename.txt Following ~C++~, the file is closed when the variable is destroyed. +*** The ~dev_utils~ module + +This module contains utilities for ~pugs~ developers. + +**** ~dev_utils~ provided functions + +#+NAME: get-module-info-dev-utils +#+BEGIN_SRC pugs :exports both :results output + cout << getModuleInfo("dev_utils") << "\n"; +#+END_SRC +#+RESULTS: get-module-info-dev-utils + +***** ~getAST: void -> string~ + +Gets the abstract syntax tree (AST) that will be executed into a ~string~. + +***** ~getFunctionAST: function -> string~ + +Gets the abstract syntax tree associated to a user function into a +~string~. + +***** ~saveASTDot: string -> void~ + +Saves the AST of the script into the file (whose name is given as +argument) using the dot format. + *** The ~math~ module The ~math~ module is a small utility module that provides a set of