ajaxdoc Forum Rss Feed

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.

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

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)?

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.

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?

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

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?