SleelaDoc API
HTML documentation for the SLeeLa standard library (/lib)
Home › Glossary

Glossary — terms and the reading level

These pages are written to be clear to a Student 2. That term, and the core SLeeLa terms used throughout, are defined here.
Student 2
A capable adult learner who is good enough to study at college again — returning to the books and to learning what is true. Not a beginner who needs everything spelled out, and not a specialist who needs nothing explained: a serious reader who wants plain, defined, unhurried prose that respects both their intelligence and their fresh start. Every explanation on these pages aims at the Student 2.
Class
A named unit of SLeeLa that bundles together values (fields) and actions (methods). It is the main building block of the library — one class per source file.
Struct
Like a class, but intended chiefly as a plain record of values. In SLeeLa a struct groups related fields under one name.
Field
A named value that a class or struct stores. Reading the fields tells you what the unit remembers.
Method
A named action a class can perform. Reading the methods tells you what the unit can do. A method has a signature (its return type, name, and the values it takes in) and a body (the steps it runs).
Signature
The one-line shape of a method or field: its type, its name, and — for a method — the parameters it accepts. The signature is the contract; the body is the fulfilment.
Facade (SLPackage)
A small class named SLPackage that presents a whole package to the compiler and loader. It names the package and reports whether it is available; it carries no domain logic of its own.
Metadata Class record
A standing SLeeLa convention: every new class carries eleven catalogued provenance attributes — version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, and national schedule — each with a get/set accessor. It records who made a unit, under what authority, and with what intent. These accessors are summarised rather than listed on each page.
SleelaDoc
SLeeLa's in-source documentation convention — doc-comments that make a source file self-describing, the way Javadoc does for Java, but documenting intent rather than only signatures. This HTML site is built from the explanations SleelaDoc and the ordinary source comments carry.
Package
A top-level folder under /lib that groups related classes into one family (for example, xml, codecs, or compression).