Project

General

Profile

Bug #1092

Find/Develop Documentation Tools For XBL and Javascript

Added by Matthew Brooke over 15 years ago. Updated over 13 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)

History

#1 Updated by Matthew Brooke over 14 years ago

tried this and it works well for .js files - generated a javadoc page for
jalama_library.js which looked good.

Doesn't parse the javadoc from XBL binding files though

http://jsdoc.sourceforge.net/

#2 Updated by Matthew Brooke over 14 years ago

tried this and it works well for .js files - generated a javadoc page for
jalama_library.js which looked good.

Doesn't parse the javadoc from XBL binding files though

http://jsdoc.sourceforge.net/

#3 Updated by Matthew Brooke almost 14 years ago

still desirable.
reduced priority - not needed for 1.0.0beta1

#4 Updated by Matthew Brooke over 13 years ago

end of grant cleanup. Postponing

#5 Updated by Redmine Admin over 5 years ago

Original Bugzilla ID was 1092

Also available in: Atom PDF