Bug #5535
closed
Improve documentation for exposed node properties
100%
Description
The documentation about XDM nodes makes reference to the fact that we've added properties to some of the node types, but doesn't actually enumerate the properties that we expect to be public.
We should use the externs for the node classes to derive the public properties and document them.
Related issues
Updated by Norm Tovey-Walsh over 2 years ago
- Related to Bug #5494: Properties of attribute nodes have internal names which change from one release to another added
Updated by Debbie Lockett 2 months ago
We also use our own classes for namespace and attribute nodes (see NamespaceNode and AttributeNode in src/nsnode.js), and these are not documented (but they probably should be).
Updated by Debbie Lockett 14 days ago
Changes committed on the main branch, for SaxonJS 3: I added documentation for NamespaceNode and AttributeNode in xdm/nodes. These internal classes are exposed on the SaxonJS object, and included in externs/Generated.js.
Updated by Debbie Lockett 7 days ago
- Category set to Documentation
- Status changed from New to Closed
- Assignee set to Debbie Lockett
- % Done changed from 0 to 100
- Fixed in JS Release set to SaxonJS 3.0
- Applies to JS Branch Trunk added
- Fix Committed on JS Branch Trunk added
Bug fix applied in the Saxon 3.0.0-beta1 preview release.
I'm closing this issue, because I think the documentation (at https://www.saxonica.com/saxonjs/documentation3/index.html#!xdm/nodes) now covers everything we want it to:
-
AttributeNodeandNamespaceNodeare now fully documented. - Otherwise we use DOM Node classes to represent XML nodes, so users should refer to external documentation for those (e.g. https://developer.mozilla.org/en-US/docs/Web/API/Node).
- We do only add a couple of our own properties (e.g.
_saxonBaseUri, and_saxonDocUri) which may be exposed to users, but they are really for internal use (as indicated by the use of the underscore prefix), and should not be relevant for users, so they don't require "full" documentation. (Note that these property names do not appear in the externs files, because all code references use bracket notation, so there's no risk of renaming with the closure compiler.)
Please register to edit this issue
Also available in: Atom PDF Tracking page
.