FreeBASIC documentatie

Documentatiedekking: 12 van 25 elementen heeft echt broncommentaar (48.0%)

Aanroepstructuur

5 functies, 13 relaties. Van links naar rechts: aanroeper voor aangeroepene. Klik een blok om naar de documentatie te springen; beweeg erover om alleen de eigen relaties te zien. Sleep om te verschuiven, scrollwiel of de knoppen rechtsonder om te zoomen.
Dikke rand = geen aanroeper binnen de gescande code (ingang of dode code). Gestippelde rand = private. Grijs gestippeld blok = referentieproject. Oranje gestippelde pijl = terugkoppeling of recursie. Blauwe fijngestippelde pijl = callback of onException van een service-aanroep.
Parts: voorraad.bas

Mogelijk ongebruikte code

3 functie(s) zonder aanroeper binnen de gescande code, 3 ingang(en) en 0 via een property gekoppelde functie(s).
Dit is een aanwijzing, geen bewijs: aanroepen via delegates, dynamische dictionary-toegang, gegenereerde Java of vanuit code buiten de scan worden niet gezien. Scan met --follow of --refs zo veel mogelijk mee voordat je iets weggooit.

Zonder aanroeper

Functie	Part	Bestand	Roept zelf aan
`LeesVoorraad`	voorraad.bas	voorraad.bas:31	2
`ToonVoorraad`	voorraad.bas	voorraad.bas:54	1
`OudeExportRoutine` private	voorraad.bas	voorraad.bas:68	0

Een functie die zelf niets aanroept en door niemand wordt aangeroepen is de meest verdachte categorie. Roept hij wel van alles aan, dan hangt daar mogelijk een hele tak ongebruikte code onder.

Ingangen

Functies in een service, interface of programma: die worden per definitie van buiten aangeroepen.

Functie	Part
`Waarde`	Type Artikel
`LeesVoorraad`	Module voorraad.bi
`ToonVoorraad`	Module voorraad.bi

Module voorraad.bas

examplefreebasic/voorraad.bas:1

Module voorraad.bas. Bevat 6 functie(s).auto

Waarde

function Waarde() returns(Double)

Berekent de waarde van deze regel.

Returns Double — waarde van het type Double

Aangeroepen door voorraad.bas.ToonVoorraad

voorraad.bas:7

SplitsRegelprivate

private function SplitsRegel(ByRef regel As String, velden () As String) returns(Integer)

Splitst een regel op puntkomma's.

@param regel de ruwe tekstregel

Parameter	Type	Richting	Beschrijving
`ByRef`	`regel As String`		by refauto
`velden`	`() As String`		de gevonden velden

Returns Integer — het aantal velden

Aangeroepen door voorraad.bas.LeesVoorraad

voorraad.bas:16

LeesVoorraadauto

function LeesVoorraad(ByRef pad As String, lijst () As Artikel) returns(Integer)

Haalt voorraad op. Retourneert Integer.

Parameter	Type	Richting	Beschrijving
`ByRef`	`pad As String`		by refauto
`lijst`	`() As Artikel`		lijstauto

Returns Integer — waarde van het type Integer

Roept aan voorraad.bas.MeldFout, voorraad.bas.SplitsRegel

geen aanroepers binnen de gescande code

voorraad.bas:31

ToonVoorraadauto

function ToonVoorraad(lijst () As Artikel)

Toont voorraad.

Parameter	Type	Richting	Beschrijving
`lijst`	`() As Artikel`		lijstauto

Roept aan voorraad.bas.Waarde

geen aanroepers binnen de gescande code

voorraad.bas:54

MeldFout

function MeldFout(ByRef tekst As String)

Schrijft een foutmelding en houdt de teller bij.

Parameter	Type	Richting	Beschrijving
`ByRef`	`tekst As String`		by refauto

Aangeroepen door voorraad.bas.LeesVoorraad

voorraad.bas:62

OudeExportRoutineprivate

private function OudeExportRoutine()

Wordt nergens aangeroepen: kandidaat voor het opruimlijstje.

geen aanroepers binnen de gescande code

voorraad.bas:68

Velden, constanten en waarden

Naam	Type	Soort	Beschrijving
`leesFouten`	`Integer`	variable	Interne teller voor het aantal leesfouten.
`artikelen`	`Artikel`	variable	Variabele artikelen.auto

Module voorraad.bi

examplefreebasic/voorraad.bi:1

Module voorraad.bi. Bevat 2 functie(s).auto

LeesVoorraadprototype

function LeesVoorraad(ByRef pad As String, lijst () As Artikel) returns(Integer)

Leest de voorraad uit een bestand.

@param pad het volledige pad naar het CSV-bestand

Parameter	Type	Richting	Beschrijving
`ByRef`	`pad As String`		by refauto
`lijst`	`() As Artikel`		de gevulde artikelenlijst

Returns Integer — het aantal ingelezen regels, of -1 bij een leesfout

geen aanroepers binnen de gescande code

voorraad.bi:33

ToonVoorraadprototypeauto

function ToonVoorraad(lijst () As Artikel)

Toont voorraad.

Parameter	Type	Richting	Beschrijving
`lijst`	`() As Artikel`		lijstauto

geen aanroepers binnen de gescande code

voorraad.bi:35

Velden, constanten en waarden

Naam	Type	Soort	Beschrijving
`VOORRAAD_BI`		macro	Functie VOORRAAD BI.auto
`MAX_ARTIKELEN`		constant	Maximaal aantal artikelen in het magazijn.

Enumeratie ArtikelStatus

examplefreebasic/voorraad.bi:8

Status van een artikel in de voorraad.

Velden, constanten en waarden

Naam	Soort	Beschrijving
`ST_ONBEKEND`	enum	Waarde ST ONBEKEND.auto
`ST_LEVERBAAR`	enum	Artikel is leverbaar.
`ST_UITVERKOCHT`	enum	Waarde ST UITVERKOCHT.auto

Type Artikel

examplefreebasic/voorraad.bi:16

Eén regel uit de voorraadadministratie.

Waardeprototype

function Waarde() returns(Double)

Berekent de waarde van deze regel.

Returns Double — waarde van het type Double

geen aanroepers binnen de gescande code

voorraad.bi:25

Velden, constanten en waarden

Naam	Type	Soort	Beschrijving
`nummer`	`Integer`	variable	Uniek artikelnummer.
`omschrijving`	`String`	variable	Variabele omschrijving.auto
`aantal`	`Integer`	variable	Variabele aantal.auto
`prijs`	`Double`	variable	Variabele prijs.auto
`status`	`ArtikelStatus`	variable	Variabele status.auto