Project

General

Profile

Actions

Bug #1092

open

Find/Develop Documentation Tools For XBL and Javascript

Added by Matthew Brooke over 21 years ago. Updated about 19 years ago.

Status:
In Progress
Priority:
Normal
Assignee:
Category:
jalama-general
Target version:
Start date:
06/05/2003
Due date:
% Done:

0%

Estimated time:
Bugzilla-Id:
1092

Description

Need something that works kinda like javadoc so we can pull all the comments and
method.function signatures from the XBL objects and javascript we write.

Dave vieglais mentioned:

js2doxy.pl - http://jsunit.berlios.de/internal.html - which generates C++ pseudo-code from
javascript , and then doxygen (http://www.stack.nl/~dimitri/doxygen) is used to generate
documentation from the C++ pseudo-code. This may work for .js files, but wouldn't work
(probably) for XBL files.

Other options include:

1) using XSLT to transform the XBL files and pull the required data, although this might
be difficult becaus ethe "javascript" comments are currently inside XML <!-- --> comment
tags, so might be ignored by the XSLT parser - is there any way around this?

2) writing a script to parse the files and pull the documentation by pattern-matching -
shoudl be relatively sraightforward since the XBL files are well-structured (XML)

Actions

Also available in: Atom PDF