japbdoc.pb

Included Files:
lexer.pbi
Included in:

Overview


Description

Coded by Remi Meier © 2006
hope it works as expected ;)

ATTENTION Read the ReadMe.html :D

ToDo:
A bit of syntax-coloring

Top, Back


Constants
#c1
unimportant const
#c2
important const
#c3
very important one!! :D
#c4
#ConstTest
a Test for a constant
#DQUOTE$
#MAX_ELEMENTS
The maximum of elements a structure/interface can have
#MAX_PARAMETERS
The maximum of parameters a procedure can have
#StringNotStart
#StringOnlyStart

Top, Back


Structures and Interfaces
CONSTANT
a structure for the constants
ELEMS
a structure for the elements of a structure
FILEDESC
FUNCTION
a structure for the functions
GLOBALS
a structure with global variables in it
GLOBALVARS
a structure for all global variables
INCLUDE
a structure for the includes
itest
An interface description
PARAM
a parameter of a procedure
REPLACECHARS
STRUCT_INTERF
a structure holding the information about structures and interfaces
test extends POINT
Just a structure for testing
TOKEN
A token of the parsed source file

Top, Back


Global Variables
aaa_Ddd.iPBSC
constant.CONSTANT()
filedesc.FILEDESC()
filestoparse.String()
function.FUNCTION()
the list of functions
glob.GLOBALS
glob is a global variable...
globalvar.GLOBALVARS()
all global variables
include.INCLUDE()
the list of includes used in this file
strucinterf.STRUCT_INTERF()
list for all structures and interfaces
token.TOKEN()
global list with the scanned pb-file

Top, Back


Functions and Macros
AddConstant(Name.s, Desc.s)
Adds a constant to the list
AddFunction(Listparams.PARAM(), FuncName.s, FuncLine.s, Export.l, Desc.s)
adds a function to the function list
AddGlobalVar(Name.s, Line.s, Desc.s)
adds a global var to the list of global vars
AddStrucInterf(Name.s, Parent.s, Listelements.ELEMS())
Adds a structure or interface to the list
d()
aha? doch!
FillTargetConstant(Target.s, Desc.s)
adds a description to a constant
FillTargetFunction(Target.s, Desc.s)
adds a description to a function/param
FillTargetGlobalVar(Target.s, Desc.s)
adds a description to a global variable
FillTargetStructure(Target.s, Desc.s)
Adds a description to a structure/interface (element)
GetAllFunctionsOverview.s()
returns the html-table of all functions - overview
GetConstantsOverview.s()
returns the html-table of constants - overview
GetDLLFunctionsOverview.s()
returns a html-table of all exported functions
GetFileDescription.s()
returns the html-string with the file desc.
GetFileNameFromParameter()
examines the file names and filters through the program parameters.
GetFunctionsDetailsList.s()
returns html-string of detailed long-description list of functions/macros
GetGlobalsOverview.s()
returns the html-table of globals - overview
GetIncludedIn.s()
returns the html-string with the table included-in-files
GetIncludeFiles.s()
returns the html-string with the table for include files
GetStrucInterfDetailsList.s()
returns html-string of details of structures and interfaces
GetStructInterfOverview.s()
returns a html-string with a table of an overview of structures and interfaces
k()
LoadFile.l(FileName.s)
loads the file and tokenizes it
main.l()
main function
othermacro(a, b = 4)
a testmacro complex mode
PreProcessHTMLLine.s(Line.s)
Changes a '_' at the end of the line to a line break
ProcessCommentParameters.l(Comment.s)
will read parameters in comments.
ProcessConstantLine()
parses a line with a constant
ProcessFile.l()
starts parsing of the loaded file
ProcessGlobalsLine()
parses a line with global variables
ProcessIncludeLine()
parses (x)include lines
ProcessProcedureLine()
parses the line starting with 'procedure' or 'macro'
ProcessProgramParameter.s(s.s, param.s, inFile = #False)
checks, if s.
ProcessStrucInterf()
parses a structure or interface block with its elements
ReplaceMultipleChars.s(String.s, *Characters.REPLACECHARS)
Replaces multiple chars with strings
ResetArray(*mem, Size.l)
resets all memory to 0
RestyleCode.s(Line.s)
Inserts links to structures (extern or intern) Restyles a bit
testmacro
a testmacro simple mode
ValidElement.l(Name.s)
checks if the name is ok with the filters
WriteOutFile.l(inFileName.s, outFileName.s, Template.s)
writes the actual html-file

Top, Back


Exported Functions
d()
aha? doch!
k()

Top, Back


CONSTANT

a structure for the constants

Elements:

Desc.s
FileName.s
lcName.s
Name.s

Top, Back


ELEMS

a structure for the elements of a structure

Elements:

Desc.s
lcName.s
Line.s
Name.s

Top, Back


FILEDESC

Elements:

FileDesc.s
FileName.s

Top, Back


FUNCTION

a structure for the functions

Elements:

Export.l
DLL or not
FileName.s
lcName.s
Line.s
func.d(a.l, b.d)
Name.s
Params.PARAM[#MAX_PARAMETERS]
ShortDesc.s

Top, Back


GLOBALS

a structure with global variables in it

Elements:

CurrentFileName.s
FilterNoConstants.l
FilterNoDLLTable.l
FilterNoFunctions.l
FilterNoGlobals.l
FilterNoSort.l
FilterNoSortField.l
FilterNoSortPaFl.l
FilterNoSortParam.l
FilterNoStructs.l
FilterNotStartWith.s[16]
FilterOnlyDLLs.l
FilterStartWith.s[16]
StyleSheet.s

Top, Back


GLOBALVARS

a structure for all global variables

Elements:

FileName.s
lcName.s
Line.s
Name.s
ShortDesc.s

Top, Back


INCLUDE

a structure for the includes

Elements:

FileName.s
lcPath.s
Name.s
Path.s

Top, Back


itest

An interface description

Elements:

elem1.s(a.l, b.c)
the first element
elem2.l(d.s)
the second element
elem3.l(f.d)
elem4.l()
"i" for showing: it's an interface. "s " would work here, too!

Top, Back


PARAM

a parameter of a procedure

Elements:

Desc.s
lcName.s
Name.s

Top, Back


REPLACECHARS

Elements:

chars.c[50]
strings.s[50]

Top, Back


STRUCT_INTERF

a structure holding the information about structures and interfaces

Elements:

Elems.ELEMS[#MAX_ELEMENTS]
FileName.s
lcName.s
Name.s
Parent.s
ShortDesc.s

Top, Back


test extends POINT

Just a structure for testing

Elements:

elem1.s
you can also put a description here!
elem2.l
or here ;), you can just document an element ONCE! (else overwritten)
elem3.l
the third element can be addressed like this when you before adressed the structure/interface explicitly. you can even leave the "s "
elem4.l
normal

Top, Back


TOKEN

A token of the parsed source file

Elements:

LineNb.l
s.s
Type.l

Top, Back


AddConstant(Name.s, Desc.s)

Adds a constant to the list

Parameters:

Desc
Name

Top, Back


AddFunction(Listparams.PARAM(), FuncName.s, FuncLine.s, Export.l, Desc.s)

adds a function to the function list

Parameters:

Desc
Export
FuncLine
The function with its parameters: func.s(a.l, b.c)
FuncName
Name of function
List

Top, Back


AddGlobalVar(Name.s, Line.s, Desc.s)

adds a global var to the list of global vars

Parameters:

Desc
Line
name with type specification: a.l
Name
name of the global variable

Top, Back


AddStrucInterf(Name.s, Parent.s, Listelements.ELEMS())

Adds a structure or interface to the list

Parameters:

List
Name
the name
Parent
the extended structure

Top, Back


d()

aha? doch!

Top, Back


FillTargetConstant(Target.s, Desc.s)

adds a description to a constant

Parameters:

Desc
Target

Top, Back


FillTargetFunction(Target.s, Desc.s)

adds a description to a function/param

Parameters:

Desc
the description for the function/param
Target
target like "functionname.param"

Top, Back


FillTargetGlobalVar(Target.s, Desc.s)

adds a description to a global variable

Parameters:

Desc
the description for the global variable
Target
target like "g varname"

Top, Back


FillTargetStructure(Target.s, Desc.s)

Adds a description to a structure/interface (element)

Parameters:

Desc
the description for the structure/interface/element
Target
target like "structurename.elem"

Top, Back


GetAllFunctionsOverview.s()

returns the html-table of all functions - overview

Top, Back


GetConstantsOverview.s()

returns the html-table of constants - overview

Top, Back


GetDLLFunctionsOverview.s()

returns a html-table of all exported functions

Top, Back


GetFileDescription.s()

returns the html-string with the file desc.

Top, Back


GetFileNameFromParameter()

examines the file names and filters through the program parameters.

Top, Back


GetFunctionsDetailsList.s()

returns html-string of detailed long-description list of functions/macros

Top, Back


GetGlobalsOverview.s()

returns the html-table of globals - overview

Top, Back


GetIncludedIn.s()

returns the html-string with the table included-in-files

Top, Back


GetIncludeFiles.s()

returns the html-string with the table for include files

Top, Back


GetStrucInterfDetailsList.s()

returns html-string of details of structures and interfaces

Top, Back


GetStructInterfOverview.s()

returns a html-string with a table of an overview of structures and interfaces

Top, Back


k()


Top, Back


LoadFile.l(FileName.s)

loads the file and tokenizes it

Parameters:

FileName
path of file to load

Top, Back


main.l()

main function

Top, Back


othermacro(a, b = 4)

a testmacro complex mode

Parameters:

a
first parameter
b
second parameter

Top, Back


PreProcessHTMLLine.s(Line.s)

Changes a '_' at the end of the line to a line break
some others...

Parameters:

Line

Top, Back


ProcessCommentParameters.l(Comment.s)

will read parameters in comments.

Parameters:

Comment

Top, Back


ProcessConstantLine()

parses a line with a constant

Top, Back


ProcessFile.l()

starts parsing of the loaded file

Top, Back


ProcessGlobalsLine()

parses a line with global variables

Top, Back


ProcessIncludeLine()

parses (x)include lines

Top, Back


ProcessProcedureLine()

parses the line starting with 'procedure' or 'macro'

Top, Back


ProcessProgramParameter.s(s.s, param.s, inFile = #False)

checks, if s.s is a parameter and then fills the global structure if possible.
It returns param.s if it wasn't used.
inFile needs to be specified for parameter-comment-processing

Parameters:

inFile
param
s

Top, Back


ProcessStrucInterf()

parses a structure or interface block with its elements

Top, Back


ReplaceMultipleChars.s(String.s, *Characters.REPLACECHARS)

Replaces multiple chars with strings

Parameters:

*Characters
A structure with chars and strings whichshall be replaced by what
String
String where chars shall be replaced

Top, Back


ResetArray(*mem, Size.l)

resets all memory to 0

Parameters:

*mem
Size

Top, Back


RestyleCode.s(Line.s)

Inserts links to structures (extern or intern) Restyles a bit

Parameters:

Line

Top, Back


testmacro

a testmacro simple mode

Top, Back


ValidElement.l(Name.s)

checks if the name is ok with the filters

Parameters:

Name

Top, Back


WriteOutFile.l(inFileName.s, outFileName.s, Template.s)

writes the actual html-file

Parameters:

inFileName
source file name
outFileName
file name of file to create and write in
Template
the template html-file with placeholders

Top, Back