jaPBDoc.pb

Included Files:: lexer.pbi
Included in:

Overview

Description
Constants
Interfaces and Structures
Global Variables
Functions and Macros
Exported Functions

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

ATTENTION Read the ReadMe.html :D

ToDo:
A bit of syntax-coloring

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

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(params.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, elements.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()` returns 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'
`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