tibcoGI documentation

[giUser1]

dhwang,

Is there a way to ticoGI source code documentation with a Ant task?

Suppose I creating files in 'addins' with GI standard, i.e.jsx3.Class.defineInterface OR jsx3.Class.defineClass.

Thanks,

giuser1

[dhwang (Darren Hwang)]

I assume you've already checked out the source

http://generalinterface.org/docs/display/OS/Project

The tool you wan to use is under the build directory. The build.xml shows how GI creates its own api docs in an Ant task

However there's a simpler way to create your own API doc. There's a command line tool you can use, see
the jsxdoc.sh shell script
http://www.generalinterface.org/fisheye ... /tools/bin

Code: Select all

@Option(name = "-i", metaVar = "PATH", usage = "the source file; a file or a directory", required = true)
@Option(name = "-x", metaVar = "SUFFIX", usage = "causes files with this suffix to be processed if using a source directory")
@Option(name = "-xml", usage = "whether to output XML; the default is HTML output")
@Option(name = "-o", metaVar = "PATH", usage = "the output directory", required = true)
@Option(name = "-a", metaVar = "ACCESS", usage = "the access level to document {PRIVATE, PACKAGE, PROTECTED, PUBLIC}", required = false)
@Option(name = "-title", metaVar = "TITLE", usage = "the documentation title", required = false)
@Option(name = "-copyright", metaVar = "COPYRIGHT", usage = "the documentation copyright notice", required = false)


[giUser1]

Thanks a lot, I'll try both.

[giUser1]

dhwang,

I'm not clear how to use the command tools with those options?

Thanks,

giUser1