Feature #1935: .NET API documentation file - Saxon - Saxonica Developer Community

Actions

Send by e-mail Copy link

Feature #1935

closed

.NET API documentation file

Added by O'Neil Delpratt about 11 years ago. Updated almost 10 years ago.

Status:

Closed

Priority:

Normal

Assignee:

O'Neil Delpratt

Category:

.NET API

Sprint/Milestone:

Start date:

2014-12-03

Due date:

% Done:

100%

Estimated time:

(Total: 0:00 h)

Legacy ID:

Applies to branch:

Fix Committed on Branch:

Fixed in Maintenance Release:

Platforms:

Description

Reported by Max Toro:

Saxon .NET requirement for the XML documentation file of the API, which can be used under Visual Studio and in code browsing in Reflector, etc.

Currently we issue the file Saxon.Api.xml, but it uses a format different from what

Visual Studio uses:

<?xml version="1.0" encoding="UTF-8"?>
<package id="Saxon.Api">
   <class id="Processor" fulltype="Saxon.Api.Processor" visibility="public"
          superclass="object"
          superclassfulltype="System.Object">

...

Should be something like:

<?xml version="1.0" encoding="UTF-8"?>
<doc>
   <members>
      <member name="T:Saxon.Api.Processor">

Sub-issues 1 (0 open — 1 closed)

Actions

Copy link

Updated by Max Toro about 10 years ago

I was hoping 9.6 would include the API documentation file.

Actions

Copy link

Updated by O'Neil Delpratt about 10 years ago

Category set to .NET API
Status changed from New to In Progress
Priority changed from Low to Normal
Legacy ID set to 9.6

Thanks for flagging this up again. We are investigating a solution and will report back shortly.

Actions

Copy link

Updated by O'Neil Delpratt about 10 years ago

Status changed from In Progress to Resolved
Legacy ID deleted (~~9.6~~)
Found in version set to 9.6

The API documentation file has now been uploaded in the saxon-resources9-6.zip on the website under doc/dotnetdoc folder

Actions

Copy link

Updated by Max Toro about 10 years ago

I cannot find the saxon-resources9-6.zip, it's supposed to be under http://sourceforge.net/projects/saxon/files/Saxon-HE/9.6/ right?

I appreciate you publishing this file, but is there any chance you include it in the Saxon distribution? The main use for this file is Intellisense, so unless it's saved in the bin folder right next to saxon9he-api.dll it doesn't help much, and having to make an additional download seems like a waste. That also means you'd have to update saxon-resources9-6.zip for every release so they don't go out of sync. The doc file shouldn't be separate from the binary.

Actions

Copy link

Updated by O'Neil Delpratt about 10 years ago

You can download saxon-resources9-6.zip from the following link:

http://www.saxonica.com/download/saxon-resources9-6.zip

Which is on our download page:

http://www.saxonica.com/download/download_page.xml

You will have to move the file next to the dll library. In the next maintenance release we will automatically package the apidoc.xml file with the dll library.

Actions

Copy link