AjaxDoc

New Post: No output

daver77 — Mon, 05 Mar 2012 13:44:58 GMT

Hi,

I have a JavaScript files like this

if (typeof (MPS) == "undefined") { MPS = {}; }

MPS.Global = {

	resizeScreenToFull: function () {
		///<summary>
		/// Make full screen
		///</summary>

		window.top.moveTo(0, 0);
		window.top.resizeTo(screen.availWidth, screen.availHeight);
	}
}

I have created a project file like this

<?xml version="1.0" encoding="utf-8" ?>
<!-- This project documents the Atlas framework itself. -->
<project xmlns:scriptdoc="http://www.w3.org/2001/XMLSchema-instance"
  scriptdoc:noNamespaceSchemaLocation="ScriptDocProject.xsd">
	<scripts>
		<script path="/Membership/MPS.Global.js" />
	</scripts>
	<namespaces>
		<namespace>MPS</namespace>
		<namespace>MPS.Global</namespace>
	</namespaces>
</project>

The output I get from AjaxDoc is
<?xml version="1.0" encoding="utf-8"?>

<reflection xmlns:js="http://www.w3.org/2001/XMLSchema-instance"
	js:noNamespaceSchemaLocation="reflection.xsd">
	<assemblies/>
	<apis>

		<api id="N:J#MPS">
			<apidata group="namespace" name="MPS"/>
			<elements>
			</elements>
		</api>

		<api id="N:J#MPS.Global">
			<apidata group="namespace" name="MPS.Global"/>
			<elements>
			</elements>
		</api>
	</apis>
</reflection>



Does anyone know what i'm doing wrong? It looks like it's not seeing any function names

New Post: How to use ajaxdoc

vkszn — Mon, 04 Oct 2010 05:29:26 GMT

I am not able to figure it , How to use this tool for generating comments for my scripts.

I would appreciate, if you can provide a little tutorial about this or an example. Do I need to use this project dll.

New Post: JavaScript error

razi241 — Tue, 13 Apr 2010 21:10:53 GMT

After trying to use following JS file for test document generation, output .org and .xml files are generated using default.aspx however to convert these to web or chm, ajaxdoc plugin doesn't work with SHFB. Versions used are new, so I was wondering if AjaxDoc can't be used for plain javascript file, rather only for ones in .net Web projects.

- test.js

var ns1 = {};
ns1.testClass = function() {
/// <summary>
/// summary descriotion for testClass
/// </summary>
}
ns1.funct1 = function() {
/// <summary>
/// this is a test
/// </summary>
return;
}

- versions

New Post: wow. this is an orphan

sky — Fri, 24 Jul 2009 23:28:44 GMT

i guess bertrand has orphaned this project. too bad. I could use some help getting it going.

New Post: Links to Microsoft Ajax

TBert — Mon, 29 Jun 2009 09:17:56 GMT

Hello,

I'm using AjaxDoc and Sandcastle to create a client-side class library reference for my project. My help collection is created to be plugged into MSDN collection; so, I use index links from my help to MSDN.

All the links work fine but I have some problems with links to Microsoft Ajax. For example, I need to make a link to Sys.UI.Control class. I discovered that the page with this class description has c0bdaa52-e536-4078-a50b-4ea8438b8ed4 guid and the same "A" keyword:

<MSHelp:Keyword Index="A" Term="c0bdaa52-e536-4078-a50b-4ea8438b8ed4" />

So, to refer to this page I need to use the same keyword, like this:

<mshelp:link keywords="c0bdaa52-e536-4078-a50b-4ea8438b8ed4" tabindex="0">Sys.UI.Control</mshelp:link>

To obtain guids I've tried to apply the AddGuidFilenames.xsl Sandcastle transform to MicrosoftAjax.org available in the Downloads section. But it makes a wrong guid (7b95bf48-b9ca-2c10-6c9c-f7708936b2a2) for T:J#Sys.UI.Control id.

It seems like Microsoft and AjaxDoc create different ids for client types. Any ideas?

Tanya

New Post: Reading comments from non Atlas type JavaScript

andyofengland — Thu, 16 Apr 2009 10:58:55 GMT

Hi,

I've got a few doxen JS files which need documenting and I'm struggling to get this working on just a few of them.

The JS files contain code along the lines of:

function doSomething(val1, val2)
{
/// <summary>
/// Does something
/// </summary>
/// <param name="val1">The first value.</param>
/// <param name="val2">The second value.</param>
/// <returns>Returns the division of the <paramref="val1"/> and <paramref="val2">.</returns>
return -1;
}

String.prototype.someStub = function()
{
/// <summary>
/// Some Stub
/// </summary>
/// <returns>Returns true.</returns>
return true;
}

and
if (!window.$myNS)
{
window.$myNS = new Array();
window.$myNS.SomeFunction = new function() { // do something }

It's not possible to change all the code but I still want to extract the comments into a usable form.
Is this possible with AjaxDoc? If so, how can I get this to work as I'm not getting anything out from the tool.

The project file resembles:

xml version="1.0" encoding="utf-8" ?>

project xmlns:scriptdoc="http://www.w3.org/2001/XMLSchema-instance"

scriptdoc:noNamespaceSchemaLocation="ScriptDocProject.xsd">

scripts>

scripts>

namespaces>

namespace></namespace>

</namespaces>

singletons>

singleton>$myNS</singleton>

</singletons>

project>

Please advise.

Thanks,

Andy

New Post: Reading comments from non Atlas type JavaScript

andyofengland — Thu, 16 Apr 2009 10:58:47 GMT

Hi,

I've got a few doxen JS files which need documenting and I'm struggling to get this working on just a few of them.

The JS files contain code along the lines of:

function doSomething(val1, val2)
{
/// <summary>
/// Does something
/// </summary>
/// <param name="val1">The first value.</param>
/// <param name="val2">The second value.</param>
/// <returns>Returns the division of the <paramref="val1"/> and <paramref="val2">.</returns>
return -1;
}

String.prototype.someStub = function()
{
/// <summary>
/// Some Stub
/// </summary>
/// <returns>Returns true.</returns>
return true;
}

and
if (!window.$myNS)
{
window.$myNS = new Array();
window.$myNS.SomeFunction = new function() { // do something }

xml version="1.0" encoding="utf-8" ?>

project xmlns:scriptdoc="http://www.w3.org/2001/XMLSchema-instance"

scriptdoc:noNamespaceSchemaLocation="ScriptDocProject.xsd">

scripts>

scripts>

namespaces>

namespace></namespace>

</namespaces>

singletons>

singleton>$myNS</singleton>

</singletons>

project>

Please advise.

Thanks,

Andy

New Post: Can't get any ouput.

dariocravero — Fri, 13 Feb 2009 19:59:14 GMT

Hi,
I'm having a problem here.. I've tried to build an example, so I make a project called Kinexo.
I've run the server using the WebDev.WebServer.exe tool as you pointed in a previous discussion. The problem is that I just won't get any output! The output directory is writtable by all users.
Here's the Kinexo.project.xml file:

<?xml version="1.0" encoding="utf-8" ?>

<project xmlns:scriptdoc="http://www.w3.org/2001/XMLSchema-instance"
scriptdoc:noNamespaceSchemaLocation="ScriptDocProject.xsd">
<scripts>
    <script path="Kinexo.js"/>
</scripts>
<namespaces>
    <namespace>Kinexo</namespace>
</namespaces>
</project>

and here's the Kinexo.js file:

Type.registerNamespace("Kinexo");

Kinexo.Tool = function() {
    /// <summary>
    ///   Constructor. Kinexo Tool.
    /// </summary>

    Kinexo.Tool.initializeBase(this);
}

Kinexo.Tool.prototype = {
    initialize: function() {
        /// <summary>
        ///   Initialize.
        /// </summary>

       Kinexo.Tool.callBaseMethod(this, "initialize");
    },

    dispose: function() {
        Kinexo.Tool.callBaseMethod(this, "dispose");
    }
}

Kinexo.Tool.registerClass("Kinexo.Tool", Sys.Component);

If you could give me a hand on this I would be really thankful since it's a really great tool.
Thanks in advance for your reply.
Best regards.
Darío

New Post: What is a Singleton

bertrandleroy — Fri, 13 Feb 2009 06:32:05 GMT

A singleton is a unique instance of a class. For example, Sys.Application is the only instance of Sys._Application. The tool singles this out because what you want to appear in the docs is Sys.Application (which is an instance, not a class) instead of Sys._Application.

Created Release: AjaxDoc 1.2 (Feb 12, 2009)

bertrandleroy — Fri, 13 Feb 2009 06:27:04 GMT

This release works with .NET 3.5 SP1 and fixes all the known bugs.

Released: AjaxDoc 1.2 (Feb 12, 2009)

Fri, 13 Feb 2009 06:27:02 GMT

This release works with .NET 3.5 SP1 and fixes all the known bugs.

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.

Source code checked in, #31369

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

Fix for 8584 and 12468.

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.

Source code checked in, #31367

BertrandLeRoy — Fri, 13 Feb 2009 05:58:26 GMT

Fix for 7868 and 7889, from EWoodruff's proposed 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.