WikiMint

What WikiMint reads from your code, by language

WikiMint reads source code and writes documentation from what the code states. It reads more of some languages than others, and this page says exactly how much, so nothing on a generated page has to be taken on trust. Every row was checked against the harvester source, not against a description of it.

WikiMint logo

What WikiMint reads from your code, by language

WikiMint reads source code and writes documentation from what the code states. It reads more of some languages than others, and this page says exactly how much, so nothing on a generated page has to be taken on trust. Every row was checked against the harvester source, not against a description of it.

Reading the table

What gets read
What it readsPowerShellPythonGoC#JavaCOBOL
What the declarations say
Each parameter, its declared type, and whether it is requiredreads itreads itreads itreads itreads itreads it
The declared return or output typereads itreads itreads itreads itreads itreads it
The names this unit calls, spelled the way the code spells themreads itreads itreads itreads itreads itreads it
Whether it is written as an advanced functionreads itnot a thing herenot a thing herenot a thing herenot a thing herenot a thing here
Whether it supports WhatIf and Confirmreads itnot a thing herenot a thing herenot a thing herenot a thing herenot a thing here
What the statements do
Which files it readsnot readreads itnot readnot readnot readreads it
Which files it writesnot readreads itnot readnot readnot readreads it
Which files it only ever appends to, which is how an audit trail is told from a rewritenot readreads itnot readnot readnot readreads it
Which SQL commands it issuesnot readreads itnot readnot readnot readreads it
Whether it reads data, changes data, or touches nonenot readreads itnot readnot readnot readreads it
Calls whose target is chosen while the program runs, so the target is not in the sourcenot readreads itnot readnot readnot readreads it
Which of its calls stay inside the file and which leave itnot readreads itnot readnot readnot readreads it
A count of each kind of statement in the bodynot readreads itnot readnot readnot readreads it
CICS commandsnot a thing herenot a thing herenot a thing herenot a thing herenot a thing herereads it

// Every state above was checked against the harvester source, not against a description of it. Pinned at d144bde948.

What that changes on the page you get

Each tab on a generated page is built from the facts above. Where a language gives less, the tab says less rather than filling the space.

Part of the pagePowerShell, Go, C#, JavaCOBOL and Python
Parameter tableEvery declared parameter, with type and whether it is requiredThe same
Practitioner tabThe description and any examples, as writtenThe same
Learner tabThe description in plain termsThe same
Dependencies tabRequired parameters and the names it callsThe same, and it separates calls that stay in the file from calls that leave it, and flags any target chosen while the program runs
Software Approval tabA risk reading taken from the command's nameA risk reading from the name, raised to Destructive when the statements actually change data, plus a line saying what it reads and writes
Manager and Compliance tabsNever producedNever produced
Where it reports nothing
How to check this page