Project

Profile

Help

Feature #4694

closed

Documentation for s9api Step, Predicate, etc.

Added by Debbie Lockett almost 2 years ago. Updated 5 months ago.

Status:
Closed
Priority:
Low
Assignee:
Category:
Documentation
Sprint/Milestone:
-
Start date:
2020-08-25
Due date:
% Done:

100%

Estimated time:
Legacy ID:
Applies to branch:
10, 11, trunk
Fix Committed on Branch:
11, trunk
Fixed in Maintenance Release:
Platforms:

Description

It would be good to add more in the documentation about the s9api interface mechanisms for navigating XML documents using Java Streams (which was new in 9.9). i.e. the s9api classes Step, Predicate, etc. (These are also going to be available in the .NET API in Saxon 10.)

There is a good section of information in the change log, under 9.9 changes in the S9API interface (see "Navigating XML Documents Using s9api" at http://www.saxonica.com/documentation/index.html#!changes/s9api/9.8-9.9); but information only in the change log can easily get buried. There is a brief mention under xpath-api/xdm-values, and the javadoc comments are also fairly good (e.g. they provide a few examples); but further details, and examples, in another section of the documentation would be useful for new users.

Actions #1

Updated by Michael Kay almost 2 years ago

Yes, indeed - especially we need more prominence for this, and more examples. I've been wondering where it should go: I think we really need a chapter devoted to the Java API, and probably another devoted to the .NET API (perhaps they can be single-sourced?), which should perhaps pull in information from some of the other chapters. The overall structure has become a bit fossilised. And it could do with much better navigation aids.

Actions #2

Updated by Michael Kay 5 months ago

I've added substantially to the Javadoc of the relevant classes (on the 11.x branch)

Actions #3

Updated by Michael Kay 5 months ago

  • Status changed from New to Resolved
  • Applies to branch 11, trunk added
  • Fix Committed on Branch 11, trunk added

I have also extended the API documentation on the C# side, and am now closing the issue.

Actions #4

Updated by Debbie Lockett 5 months ago

  • Status changed from Resolved to Closed
  • % Done changed from 0 to 100
  • Fixed in Maintenance Release 11.2 added

Bug fix applied in the Saxon 11.2 maintenance release.

Actions #5

Updated by Debbie Lockett 5 months ago

Closed bug, since we don't plan to make any such changes the Saxon 10 documentation now.

Please register to edit this issue

Also available in: Atom PDF