This project has moved and is read-only. For the latest updates, please go here.

XML Doc comments in JS

Jul 23, 2014 at 4:06 PM
Hi,

I'm using ClearScript to provide extension points in one of our applications. As part of our build process, we're using Doxygen to generate API documentation for internal use. I'm having some trouble getting links in the documentation for the javascript extensions back to some of our .Net types to reference correctly.

Here's an example:

JS:
function DoSomething(utilities){
    ///<param name="utilities">An instance of foo.JSUtilities</param>
    ///<seealso cref="foo.JSUtilities" />
    // do stuff
}
C#:
namespace foo {
    public class JSUtilities {
    }
}
Is there some trick that I'm not getting to allow the JS xml docs to reference .Net types? Links within JS or within C# functions and types are fine, it only appears to be an issue where I'd like to reference C# types and functions from the JS xml comments.
Jul 23, 2014 at 7:11 PM
Greetings!

If we understand correctly, you have a set of JavaScript and C# source files for which you'd like to build a single, merged set of documentation. If that's correct, your question would appear to be about Doxygen rather than ClearScript, unless the latter is somehow involved in the documentation building process.

Please let us know if we misunderstood your question. Thanks!