Project

Profile

Help

Bug #4487

closed

10 documentation app javadoc search is broken

Added by Debbie Lockett about 4 years ago. Updated almost 4 years ago.

Status:
Closed
Priority:
Normal
Category:
-
Sprint/Milestone:
-
Start date:
2020-03-20
Due date:
% Done:

100%

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

Description

It should be possible to search the javadoc for class and method names, etc. by prefixing search terms with '#'. This doesn't seem to be working. The app just hangs.

It might be because the dotnetdoc isn't there, or there could be some more serious issue in the app (or the Saxon-JS build).

Actions #1

Updated by Debbie Lockett about 4 years ago

  • Status changed from New to In Progress

In fact the reason seems to be "all of the above":

  1. The missing dotnetdoc files is the first issue. This requires a temporary change in the findtext.xsl app stylesheet, to only try to search javadoc for now (while Saxon 10 is only available on Java).

  2. Resolving 1 unfortunately reveals a performance issue for Saxon-JS on the 2.0 development branch. I will raise this as an internal bug. The javadoc search does work eventually, but it takes far too long. So I am going to revert to using Saxon-JS 1.2 for the 10 documentation app.

The reason for not using Saxon-JS 1.2 in the first place was to do with handling ordering of version numbers, to get the Change History section working correctly. We had been ordering as strings, which broke once we moved to version "10.0". Note that it is not straight forward to instead compare as numbers, because we use 3 part version numbers (e.g. 9.9.1, 9.5.1). The Saxon-JS 2 solution is to use a collation which handles this ('http://www.w3.org/2013/collation/UCA?lang=en;numeric=yes'), but this is not available in Saxon-JS 1.

I have now written a Saxon-JS 1 solution: a user function to convert version number strings (e.g. "9.9.1") to numbers (9.91), so that we can compare version numbers easily as doubles. The required changes are in the changes.xsl stylesheet.

Actions #2

Updated by Debbie Lockett about 4 years ago

  • Status changed from In Progress to Resolved
  • Fix Committed on Branch 10 added

10 documentation app updated online: SEF update, and revert to use Saxon-JS 1.2.

Changes committed in userdoc on dev branch.

Marking as resolved because the online javadoc search does now work.

But not closing because the saxon-resources which contains the documentation app have not yet been updated. The saxon-resources will be updated with the next maintenance release.

Actions #3

Updated by O'Neil Delpratt almost 4 years ago

  • % Done changed from 0 to 100
  • Fixed in Maintenance Release 10.1 added

Bug fix committed in the Saxon 10.1 maintenance release.

Actions #4

Updated by O'Neil Delpratt almost 4 years ago

  • Status changed from Resolved to Closed

Please register to edit this issue

Also available in: Atom PDF