Menu

Maslosoft Zamm Logo Maslosoft Zamm Documentation
Zamm is a documentation tool

Edit

Zamm Quick Start Guide

API Links and naming

Zamm can generate links to api made by apigen. To use this feature add API roots for specified namespaces:

ApiUrl::setRoot([
        '/my-project/api/' => 'Maslosoft\\MyProject'
]);

Then it can be used to create links to API of class, it's properties or methods using ShortNamer (more):

$typeUrl = new ShortNamer(ApiUrl::class);
// NOTE: setRoot is method of ApiUrl
$methodUrl = (new ShortNamer(ApiUrl::class))->setRoot();

Above will result in following links:

ApiUrl and setRoot().

Capturing code parts

Code fragments embedded in documentation can be captured with Capture. This is will slice out file fragment and store it internally. Later this can be outputted as a code example. Thus resulting in valid PHP example code.