AjaxDoc

NEW POST: How to use this

EWoodruff — Thu, 03 Apr 2008 15:18:20 GMT

Extract the ZIP file to a folder of your choice and set up a virtual directory that points to it. Optionally, you can use the .NET web server to run it like this (lines wrapped for display purposes):

"C:\Windows\Microsoft.NET\Framework\v2.0.50727\WebDev.WebServer.EXE" /port:12345
    /path:C:\DotNet20\Web\AjaxDoc\ /vpath:/AjaxDoc

The above assumes you've placed the files in the C:\DotNet20\Web\AjaxDoc\ folder. Once you run the command above, you can open a web browser and navigate to http://localhost:12345/AjaxDoc to run it manually.

If you are using the Sandcastle Help File Builder, you can use the PlugInConfigurations property to add the AjaxDoc Plug-In and configure it to point to the proper URL. Once configured, you can build a help file using it. See the plug-in documentation in the SHFB help file for more information about it. If you have any other questions about SHFB or the plug-in, ask over in the SHFB Discussion page so that I see it.

Eric

CLOSED ISSUE: "J#" Prefix causes BuildAssembler to Crash

BertrandLeRoy — Wed, 02 Apr 2008 23:44:16 GMT

The "#" is reserved to represent a period in a member name such as those for explicit interface implementation members. The "J#" prefix now used by AjaxDoc causes Sandcastle's BuildAssembler to crash. Since I can't see any reason for the prefix I'd suggest removing it altogether. I've added a workaround in the AjaxDocPlugIn to do this for now. If there is some reason that the prefix is required, it should be changed to "J." so that it merges with and becomes part of the namespace. One exception would be the global namespace which should be "N:" or "N:J" if the prefix is required (no period on it).

Eric
Comments: This has been fixed by SandCastle.

NEW POST: How to use this

JulianV — Thu, 20 Mar 2008 21:16:47 GMT

Maybe I'm missed some text, but I don't get it. How to use this tool? Can someone give some a short tutorial? I don't now where to place the files in the .zip, or which program this should open them.

Do I need the build events in visual studio or something? Or open with Sandcastle (helper)?

COMMENTED ISSUE: Class Summary Missing

bb1769 — Sun, 27 Jan 2008 23:00:49 GMT

The latest version is not able to generate the JS class summary in the XML comment files.
Comments: ** Comment from web user: bb1769 **

We found that by changing line 109 in ScriptDoc.js from:

var summary = summaryNode ? summaryNode.innerText : null;

to:

var summary = summaryNode ? summaryNode.xml : null;

caused the class/type summary to be extracted to the XML file correctly.

NEW POST: Sandcastle Help File Builder (part 2)

EWoodruff — Sat, 08 Dec 2007 21:26:24 GMT

I fixed the bug in AjaxDoc that caused the JScript syntax generator to fail. You can get a fixed version of the script from the attachment in this work item: http://www.codeplex.com/ajaxdoc/WorkItem/View.aspx?WorkItemId=7889. It also fixes another issue related to namespaces. Once you replace the script and use it with 1.6.0.2 or later of SHFB with the AjaxDoc plug-in you can generate help files using Sandcastle.

Eric

NEW POST: Sandcastle Help File Builder (part 2)

SharpGIS — Thu, 06 Dec 2007 01:39:05 GMT

I ended up reflecting the JScript syntax generator, fix the bug and recompile my own syntaxgenerator. This works great and even gives a little better control over the syntax generated (the output of my syntaxgenerator looks at lot more like javascript than what the sandcastle generator comes with).
I can't wait for it to be fixed though - I'd rather use the "real" generator than my own hacked version.

Project License Changed

Wed, 28 Nov 2007 20:40:21 GMT

Microsoft Public License (Ms-PL) This license governs use of the accompanying software. If you use the software, you accept this license. If you do not accept the license, do not use the software. 1. Definitions The terms "reproduce," "reproduction," "derivative works," and "distribution" have the same meaning here as under U.S. copyright law. A "contribution" is the original software, or any additions or changes to the software. A "contributor" is any person that distributes its contribution under this license. "Licensed patents" are a contributor's patent claims that read directly on its contribution. 2. Grant of Rights (A) Copyright Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free copyright license to reproduce its contribution, prepare derivative works of its contribution, and distribute its contribution or any derivative works that you create. (B) Patent Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free license under its licensed patents to make, have made, use, sell, offer for sale, import, and/or otherwise dispose of its contribution in the software or derivative works of the contribution in the software. 3. Conditions and Limitations (A) No Trademark License- This license does not grant you rights to use any contributors' name, logo, or trademarks. (B) If you bring a patent claim against any contributor over patents that you claim are infringed by the software, your patent license from such contributor to the software ends automatically. (C) If you distribute any portion of the software, you must retain all copyright, patent, trademark, and attribution notices that are present in the software. (D) If you distribute any portion of the software in source code form, you may do so only under this license by including a complete copy of this license with your distribution. If you distribute any portion of the software in compiled or object code form, you may only do so under a license that complies with this license. (E) The software is licensed "as-is." You bear the risk of using it. The contributors give no express warranties, guarantees or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the extent permitted under your local laws, the contributors exclude the implied warranties of merchantability, fitness for a particular purpose and non-infringement.

CREATED ISSUE: Class Summary Missing

kazimanzurrashid — Sat, 17 Nov 2007 13:51:52 GMT

The latest version is not able to generate the JS class summary in the XML comment files.

NEW POST: How to extract summary from class?

JohnBJim — Wed, 07 Nov 2007 13:20:32 GMT

I can extract summary from method, but can not extract it from class by AjaxDoc. How to deal with?

COMMENTED ISSUE: Can't use JScript Syntax Box

EWoodruff — Sat, 20 Oct 2007 01:51:02 GMT

I was trying to use the JScriptDeclarationSyntaxGenerator built into SandCastle and ran into issues. I sent an email to Anand, and he said it was being caused because AjaxDoc doesn't specify <returns> data in the reflection.org file that is generated, which is required by the JScriptDeclarationSyntaxGenerator.
Comments: ** Comment from web user: EWoodruff **

** NOTE: Ignore the script attachment on this work item. Use the attached script on the work item at [url:http://www.codeplex.com/ajaxdoc/WorkItem/View.aspx?WorkItemId=7889] as it contains a fix for the namespaces bug as well as this one.

Eric

CREATED ISSUE: Incorrect namespace handling

EWoodruff — Sat, 20 Oct 2007 01:47:21 GMT

AjaxDoc is outputing nested namespaces in the <elements> list for namespace API members. It shouldn't as this causes the nested namespace content to appear below the parent namespace as well as at the root level. It should also write out the full name rather than the short name in the <apidata> element. The fix for both problems is to modify the code between lines 307 and 335 in ScriptDoc.js. I've attached a fixed copy of the AjaxDoc 1.1 script file.

Note that this also contains the fix for the bug that causes the JScript syntax generator to fail (see the other related work item).

CREATED ISSUE: "J#" Prefix causes BuildAssembler to Crash

EWoodruff — Fri, 19 Oct 2007 19:30:27 GMT

COMMENTED ISSUE: Can't use JScript Syntax Box

EWoodruff — Fri, 19 Oct 2007 19:26:36 GMT

I found a fix for this and have attached the modified ScriptDoc.js file from the 1.1 release. It adds an "else" statement to the code in the _appendMembersReflectionDoc member at about line 566 that writes out a returns element if no member documentation is found.

NEW POST: How to use the .org file by SHFB Tool

EWoodruff — Fri, 19 Oct 2007 15:21:55 GMT

See this thread in the SHFB forum: https://www.codeplex.com/Thread/View.aspx?ProjectName=SHFB&ThreadId=16554

Eric

NEW POST: Sandcastle Help File Builder (part 2)

EWoodruff — Fri, 19 Oct 2007 15:19:40 GMT

There's currently a bug in the plug-in where if you don't add a dummy "Comment Only" XML file to the Assemblies to Document list, it won't get past the "validating assemblies" step. That will be fixed in next week's release. The workaround is to add a dummy file for the time being. The "object not set to an instance of an object" error is caused by the JScript syntax filter (Microsoft's component, not mine). A workaround noted on the MSDN Forum was to remove the VB syntax filter but I don't know if that would work. Turning off the JScript filter would also make it get past that point but of course you wouldn't have and JScript syntax section in the help file.

Eric

CREATED ISSUE: Can't use JScript Syntax Box

GeoffreyK — Thu, 18 Oct 2007 19:34:49 GMT

NEW POST: Sandcastle Help File Builder (part 2)

GeoffreyK — Thu, 18 Oct 2007 19:30:33 GMT

Luc1an,
I have successfully used the output from AjaxDoc and the SandCastle compiler to generate a CHM for my JavaScript comments. You have to jump through some hoops, but you can use the Example .bat file sent with SandCastle and modify it to generate the help.

The .xml and .org files that AjaxDoc generate have to be renamed to comments.xml and reflection.org. You also need to make a custom sandcastle.config to exclude VB syntax boxes. Currently you can't generate JScript syntax boxes because of an issue where fields don't specify return data.

I'll try to customize my build to use the MicrosoftAjax assembly, instead of my assembly, and zip that up and make it available, if I can find a place that allows me to post zips.

NEW POST: Sandcastle Help File Builder (part 2)

Luc1an — Thu, 18 Oct 2007 09:01:08 GMT

Bertrand,

Can you confirm if the reflection code that AjaxDoc generates can be successfully processed by MS sandcastle compilers (which now it's in a CTP form)? Haven't tried yet but hopefully you already have an answer.

It looks like Sandcastle Help File Builder v1.6 (http://www.codeplex.com/SHFB) still has a problem processing reflection files generated by AjaxDoc. It throws a classic error which is almost nothing: Object reference not set to an instance of an object.
I hope EWoodruff -- the owner of SHFB -- will do a documented test sample to let us know if SHFB really works with AjaxDoc reflection files. The plugin he added for AjaxDoc is a big step forward.

Right now I'm not sure where is the problem: Sandcastle, SHFB or AjaxDoc.

Thx,
Lucian Naie

NEW POST: How to use the .org file by SHFB Tool

JohnBJim — Wed, 17 Oct 2007 08:29:45 GMT

I'm a freshmen.Now,there is a problem I don't know how to deal with.After getting .xml and .org file from my script's comment ,I use SHFB to build help file.But .org is not equal with .dll or .exe.It's incorrect when running SHFB.How can I do to clear the problem?

NEW POST: What is a Singleton

GeoffreyK — Thu, 11 Oct 2007 18:03:12 GMT

I've been working on getting the AjaxDoc program working with our assembly, and almost have it working, but I don't know what a singleton is. Can someone give me some information on this?

In addition, in the project file when you specify the namespace, is that the namespace you use in the assembly itself, or the registered namespace you are using on the .js files you are documenting?