ajaxdoc Work Item Rss Feed

Commented Issue: Field summary missing

BertrandLeRoy — Fri, 13 Feb 2009 06:19:47 GMT

It seems latest version is not able to generate the JS field summary in the XML comment files.

I've tried to correct this behavior in this way:

changing line 123 in ScriptDoc.js from:

fieldDesc = fieldNode.innerText;

to:

fieldDesc = fieldNode.text;

and changing the function Bleroy.AjaxDoc._appendMemberDoc like this:

if (memberType == "F")
doc.push("\n\t\t<member name=\"" + memberType + ":J#" + memberPath + "\"" +
(memberDescription ? ">\n<summary>" + memberDescription + "</summary>\t\t</member>" : "/>"));
else
doc.push("\n\t\t<member name=\"" + memberType + ":J#" + memberPath + "\"" +
(memberDescription ? ">\n" + memberDescription + "\t\t</member>" : "/>"));

It seems to work fine for my purpose but any feedback is appreciated.
Comments: Fixed with the proposed patch. Thanks for submitting this.

Commented Issue: Class Summary Missing

BertrandLeRoy — Fri, 13 Feb 2009 06:19:47 GMT

The latest version is not able to generate the JS class summary in the XML comment files.
Comments: Fixed with the proposed patch. Thanks for submitting this.

Commented Issue: Incorrect namespace handling

BertrandLeRoy — Fri, 13 Feb 2009 05:59:12 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).
Comments: Patch applied. Many thanks for the patch.

Commented Issue: Can't use JScript Syntax Box

BertrandLeRoy — Fri, 13 Feb 2009 05:58:56 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: Patch applied. Many thanks for the patch.

Closed Issue: Bug/inconsistency in ScriptDoc for doc'ing properties

BertrandLeRoy — Fri, 13 Feb 2009 05:33:46 GMT

I found a weird inconsistency in the way I should doc properties.

If I do like this (like stated on Bertrands blog):
{{
get_enableMouseWheel : function() {
/// <value type="Boolean">Enables the mouse wheel.</value>
return this._enableMouseWheel;
}
}}
...the type is correctly set in the .org output, and the <value> tag is stored in the .xml, but <value> is not generating any textual output when I pull that through SandCastle.

If I do this:
{{
get_enableMouseWheel : function() {
/// <summary type="Boolean">Enables the mouse wheel.</summary>
return this._enableMouseWheel;
}
}}
I get my code summary, but in the .org file the type is now set to ‘Any’ (SandCastle doesn’t really document the parameters or types yet, but that's another bug that I already have reported to the SandCastle team).

Last way I can think of doing it is using both tags:
{{
get_cursor : function() {
/// <summary>Gets or sets the map cursor</summary>
/// <value type="String"/>
return this.get_element().style.cursor;
}
}}

This works, but its kinda “messy”, and not how I think it’s supposed to be done.

So in this case .xml output reads:
{{
<member name="P:J:MyClass.UI.BaseNav.cursor">
<summary>Gets or sets the map cursor name</summary>
<value/>
</member>
}}
And the .org:
{{
<api id="P:J:MyClass.UI.BaseNav.cursor">
<apidata group="member" subgroup="property" name="cursor"/>
<memberdata visibility="public"/>
<proceduredata/>
<propertydata get="true" set="true"/>
<returns><type api="T:J:String"/></returns>
<containers>
<library assembly="" module="WebADF"/>
<namespace api="N:J:MyClass.UI"/>
<type api="T:J:MyClass.UI.BaseNav"/>
</containers>
</api>
}}

Closed Issue: "Global namespace" text should be just "Global"

BertrandLeRoy — Fri, 13 Feb 2009 05:33:45 GMT

The "Global namespace" text used for the global namespace at line 303 in the getReflectionXml method in ScriptDoc.js should be changed to be just "Global". If not, the table of content for help files generated with Sandcastle reads "Global namespace Namespace".

Commented Issue: Wrong AJAX version in web.config

BertrandLeRoy — Fri, 13 Feb 2009 05:33:27 GMT

web.config references MS AJAX v. '1.0.0.0' where it should be '1.0.61025.0' (for changeset #10601).
Fixed web.config attached.
Comments: I upgraded the whole project to 3.5 so that shouldn't be an issue anymore.

Created Issue: Field summary missing

cecattom — Mon, 26 Jan 2009 13:30:47 GMT

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.

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.

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.

COMMENTED ISSUE: Can't use JScript Syntax Box

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

** 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

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.

CREATED ISSUE: Can't use JScript Syntax Box

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

CREATED ISSUE: Wrong AJAX version in web.config

SharpGIS — Thu, 27 Sep 2007 17:37:40 GMT

web.config references MS AJAX v. '1.0.0.0' where it should be '1.0.61025.0' (for changeset #10601).
Fixed web.config attached.

CREATED ISSUE: "Global namespace" text should be just "Global"

EWoodruff — Mon, 17 Sep 2007 03:05:57 GMT

CREATED ISSUE: Bug/inconsistency in ScriptDoc for doc'ing properties

SharpGIS — Wed, 22 Aug 2007 21:15:05 GMT