Project

Profile

Help

Bug #2260

Saxon.Api documentation: missing class descriptions

Added by Michael Kay over 6 years ago. Updated over 5 years ago.

Status:
Closed
Priority:
Low
Category:
Documentation
Sprint/Milestone:
Start date:
2014-12-15
Due date:
% Done:

100%

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

Description

In the Saxon.Api documentation (for .net),, the package page gives a list of classes with summary descriptions of each. This list includes classes with no summary description, only a hyperlink. For example, at the bottom of the list:

ResultDocumentHandlerWrapper XmlLocation MessageListenerProxy Xslt30Transformer XsltPackage

but there are others such as DotNetModuleUriResolver

History

#1 Updated by Michael Kay over 6 years ago

These classes also have no class description when you go to the page for the class itself. Some of them, such as DotNetModuleUriResolver, also have minimal method descriptions.

In addition (perhaps unrelated), some of the links to classes don't resolve. For example, in the page for XsltTransformer, the Property summary includes a number of properties of Saxon-defined types such as QName, XdmNode, IMessageListener; these are rendered as hyperlinks but don't resolve properly.

#2 Updated by O'Neil Delpratt over 6 years ago

  • Status changed from New to In Progress

#3 Updated by O'Neil Delpratt over 6 years ago

  • % Done changed from 0 to 80

Documentation comments added to the respective classes and committed to subversion. Currently having issues with the build.

#4 Updated by O'Neil Delpratt over 6 years ago

Bug fixed. The first part of Comment #1 has been completed. The second part I am opening a new bug issue to keep track of it. See: #2285

#5 Updated by O'Neil Delpratt over 6 years ago

  • Status changed from In Progress to Resolved

#6 Updated by O'Neil Delpratt over 6 years ago

  • % Done changed from 80 to 100

#7 Updated by O'Neil Delpratt over 6 years ago

  • Fixed in version set to 9.6.0.4

Bug fix applied in the Saxon 9.6.0.4 maintenance release.

#8 Updated by O'Neil Delpratt over 6 years ago

  • Status changed from Resolved to Closed

#9 Updated by O'Neil Delpratt over 5 years ago

  • Sprint/Milestone set to 9.6.0.4
  • Applies to branch 9.6 added
  • Fix Committed on Branch 9.6 added
  • Fixed in Maintenance Release 9.6.0.4 added

#10 Updated by O'Neil Delpratt over 5 years ago

  • Sprint/Milestone changed from 9.6.0.4 to 9.6.0.3
  • Fixed in Maintenance Release 9.6.0.3 added
  • Fixed in Maintenance Release deleted (9.6.0.4)

#11 Updated by O'Neil Delpratt over 5 years ago

  • Sprint/Milestone changed from 9.6.0.3 to 9.6.0.4
  • Fixed in Maintenance Release 9.6.0.4 added
  • Fixed in Maintenance Release deleted (9.6.0.3)

Please register to edit this issue

Also available in: Atom PDF