xmldoclinkchecker()
xmldoclinkchecker(xmldocfilename)
xmldoclinkchecker(xmldocdirectory)
[state, errors_detected, warnings_detected] = xmldoclinkchecker(target)
| Parameter | Description |
|---|---|
| target | a string: XML file or directory to check. |
| Parameter | Description |
|---|---|
| state | a logical: true if all references are resolved, false otherwise. |
| errors_detected | a cell array of strings: unresolved link references and related errors. |
| warnings_detected | a cell array of strings: warnings detected during validation. |
xmldoclinkchecker validates <link linkend="..."/> references used in Nelson help XML pages.
It checks references in a single XML file, a directory tree, or all installed module help XML files when called without arguments.
This function is useful to detect broken cross-references before building HTML/Markdown help outputs.
The link target uses the XML page file name without the .xml extension, optionally prefixed with a module name such as ${dynamic_link}havecompiler.
[state, errors_detected] = xmldoclinkchecker([modulepath('help_tools'), '/help/en_US/xml/xmldocchecker.xml'])xmldoclinkchecker([modulepath('help_tools'), '/help/en_US/xml'])| Version | Description |
|---|---|
| 1.17.0 | initial version |