Skip to content

STYLE: Improve documentation of GetFirstNode()

Francois Budin requested to merge github/fork/fbudin69500/doc_GetFirstNode into master

GetFirstNode third parameter "byHideFromEditor" was not explained in the doxygen documentation. It did not seem intuitive to have a parameter that is a pointer when one might expect to specify a boolean. The new doxygen string explains that this is a 3-state variable that is either disregarded if the pointer is set to 0, or the function only returns a node that matches the given value (hidden from editor or not).

Merge request reports

Loading