com.swfit.core.util
Class ActionScriptDoc

java.lang.Object
  |
  +--com.swfit.core.util.ActionScriptDoc

public final class ActionScriptDoc

extends java.lang.Object

ActionScriptDoc is a utility for generating very rudimentary help files from *.as files written in my style. Not very useful for anybody but me, and not very efficient either. Written in a burning hurry, as they say.

Since:

SWFIT1.0

Version:

$Revision: 1.6 $ $Date: 2003/04/21 15:14:03 $

Author:

Olaf Havnes

Inner Class Summary

static class

ActionScriptDoc.ASDComparator

Field Summary

static java.lang.String	ACTIONSCRIPT
static java.lang.String	ACTIONSCRIPT_ENDING
static java.lang.String	BACK_TO_TOC
static java.lang.String	COMMENT_END
static java.lang.String	COMMENT_START
static java.lang.String	DOWNLOAD_SOURCE
static java.lang.String	GO_UP
static java.lang.String	HIDE_COMMENT_START
static java.lang.String	HOMEPAGE_LINK
static java.lang.String	HOMEPAGE_LINK_TXT
static java.lang.String	INCLUDE_COMMAND
static java.lang.String	KEYWORD_CHAR
static java.lang.String	PREVIOUS_DOC
static java.lang.String	SCRIPT_FOLDER
static java.lang.String	SIMPLE_COMMENT
static java.lang.String	TOC_FILE
static java.lang.String	TOC_TITLE
static java.lang.String	TRAIL
static java.lang.String	XHTML_ENDING

Method Summary

static java.lang.String	commentLine(java.lang.String str)
static boolean	containsKeyword(java.lang.String str)
static void	main(java.lang.String[] args) The main method - call with single folder as input.
static java.lang.String	replace(java.lang.String str, java.lang.String remove, java.lang.String replace) String utilities.
static java.lang.String	stripASEnding(java.io.File f) Filename utility.
static java.lang.String	stripComment(java.lang.String str)
static void	traverse(java.io.File root, java.io.File dir, java.util.Vector vector) Recursive chase of actionscript docs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ACTIONSCRIPT_ENDING

public static final java.lang.String ACTIONSCRIPT_ENDING

XHTML_ENDING

public static final java.lang.String XHTML_ENDING

GO_UP

public static final java.lang.String GO_UP

SCRIPT_FOLDER

public static final java.lang.String SCRIPT_FOLDER

SIMPLE_COMMENT

public static final java.lang.String SIMPLE_COMMENT

HIDE_COMMENT_START

public static final java.lang.String HIDE_COMMENT_START

COMMENT_START

public static final java.lang.String COMMENT_START

COMMENT_END

public static final java.lang.String COMMENT_END

ACTIONSCRIPT

public static final java.lang.String ACTIONSCRIPT

KEYWORD_CHAR

public static final java.lang.String KEYWORD_CHAR

INCLUDE_COMMAND

public static final java.lang.String INCLUDE_COMMAND

TOC_FILE

public static final java.lang.String TOC_FILE

TOC_TITLE

public static final java.lang.String TOC_TITLE

BACK_TO_TOC

public static final java.lang.String BACK_TO_TOC

PREVIOUS_DOC

public static final java.lang.String PREVIOUS_DOC

TRAIL

public static final java.lang.String TRAIL

DOWNLOAD_SOURCE

public static final java.lang.String DOWNLOAD_SOURCE

HOMEPAGE_LINK

public static final java.lang.String HOMEPAGE_LINK

HOMEPAGE_LINK_TXT

public static final java.lang.String HOMEPAGE_LINK_TXT

Method Detail

main

public static void main(java.lang.String[] args)

The main method - call with single folder as input.

traverse

public static final void traverse(java.io.File root,
                                  java.io.File dir,
                                  java.util.Vector vector)
                           throws java.io.IOException

Recursive chase of actionscript docs.

stripASEnding

public static final java.lang.String stripASEnding(java.io.File f)

Filename utility.

replace

public static final java.lang.String replace(java.lang.String str,
                                             java.lang.String remove,
                                             java.lang.String replace)

String utilities.

stripComment

public static final java.lang.String stripComment(java.lang.String str)

commentLine

public static final java.lang.String commentLine(java.lang.String str)

containsKeyword

public static final boolean containsKeyword(java.lang.String str)