Book a Demo

Author Topic: More support for JavaScript modeling  (Read 4222 times)

sellind

  • EA Novice
  • *
  • Posts: 1
  • Karma: +0/-0
    • View Profile
More support for JavaScript modeling
« on: June 21, 2003, 01:11:21 am »
EA is a great product and I helps me address a number of difficult problems I have with modeling and documenting my web applications.  In my case I have a lot of complex JavaScript objects that I have modelled with EA.  An important side effect of modeling with EA is the automatically generated documentation.  I use this as API docs and since I have found no other (JavaScript) tools that are able to do this, it is a great help.  What I would like to see however is:

1. Support for import/export of structured  JavaScript code.  This would allow me to document objects and methods in the program code  (i.e. as object/method headers).  I think this task would be possible if the generated JavaScript used the "prototype" method of object extension.  This way all methods and fields would  be grouped separately and easy to parse.

2. Even without import/export, it is a great help just to have generated documentation.  But what would be even better is to have a way to generate HTML pages and other sundry files for creating compiled html help files (.CHM's).  The other format that I would be interesed to see is standard (XML) Docbook (v4.x).

thanks in advance
dennis
d.

karakas

  • EA Novice
  • *
  • Posts: 13
  • Karma: +0/-0
    • View Profile
Re: More support for JavaScript modeling
« Reply #1 on: November 18, 2004, 04:11:14 pm »
I am interested in a DocBook (SGML as well as XML) version of the automatic documentation too. DocBook is the standard in technical documentation. You should also make it possible to export the Glossary in DocBook. DocBook has special glossary tags for this.

Have a look in

http://wiki.docbook.org/topic/
« Last Edit: November 18, 2004, 04:12:29 pm by karakas »
Regards

Chris Karakas
http://www.karakas-online.de

RedDwarfDogs

  • EA Novice
  • *
  • Posts: 7
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Re: More support for JavaScript modeling
« Reply #2 on: October 22, 2005, 09:29:01 am »
We've been using JSDoc for Javascript documentation and it has been working well.  Right now I'm looking at round-triping issues with Javascript while maintaining JSDoc comments