---
title: DocBox-Ausgabebeispiel
order: 6.9
icon: phosphor-duotone:code
tags: [anleitungen, boxlang, docbox, example]
---
# DocBox-Ausgabebeispiel
Ein echtes Beispiel dafür, was [`bxSites docbox`](docbox.md) erzeugt.
Jede Seite unten stammt aus einem tatsächlichen Lauf gegen den gezeigten
Quellcode - nichts davon ist von Hand geschrieben.
Gegeben diese Klasse im Ordner `models/` eines Projekts:
```java title="models/Book.bx"
/**
* A single book on the shelf, immutable once created.
*
* @author Ortus Solutions
*/
class singleton accessors=true {
/**
* The book's title
*/
property name="title" type="string";
/**
* Where book records are read from
*/
property name="datasource" type="string" inject="coldbox:setting:bookDatasource";
/**
* Build a book.
*
* @title The book's title
* @author The book's author
*/
function init( required string title, string author = "Unknown" ) {
return this
}
/**
* Return a copy of this book with a new title.
*
* @newTitle The replacement title
*
* @return a copy carrying the new title
*/
Book function withTitle( required string newTitle ) {}
private function normalize() {}
}
```
...schreibt `bxSites docbox` die Datei `api/docbox/models/Book.md` mit
diesem Frontmatter:
```yaml title="Frontmatter"
---
title: "Book"
summary: "A single book on the shelf, immutable once created."
tags: [api, docbox]
---
```
Und diesen Body - unten nicht als Codeblock, sondern wirklich gerendert.
Das *ist* der Body der erzeugten Seite, live, samt Filterleiste. Probier
den Private-Chip oder tippe "title" in das Suchfeld:
---
## Book
`models.Book` · Class
A single book on the shelf, immutable once created.
### Annotations
- `@accessors` true
- `@singleton`
### Properties
| Property | Type | Default | Description |
|---|---|---|---|
| `title` | `string` | — | The book's title |
| `datasource` | `string` | — | Where book records are read from `@inject coldbox:setting:bookDatasource` |
### Constructor
#### `Any init( required string title, string author = "Unknown" )`
Build a book.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| `title` | `string` | yes | — | The book's title |
| `author` | `string` | no | `Unknown` | The book's author |
### Public methods
#### `Book withTitle( required string newTitle )`
Return a copy of this book with a new title.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| `newTitle` | `string` | yes | — | The replacement title |
- **Returns** a copy carrying the new title
### Private methods
#### `Any normalize()`
---
## Worauf zu achten ist
- **Dass es die Properties-Tabelle überhaupt gibt.** DocBox' eigene
JSON-Strategie lässt deklarierte `property`-Blöcke weg; bx-sites liest
sie aus denselben Klassenmetadaten nach, die DocBox verwendet hat -
deshalb stehen `title` und `datasource` hier mitsamt Hinweistext, und
deshalb überlebt auch das WireBox-`inject` auf `datasource`.
- **Der `@return`-Text überlebt aus demselben Grund** - siehe die
Returns-Zeile unter `withTitle`.
- **Private Methoden sind enthalten**, anders als beim Javadoc-Generator.
DocBox meldet sie, also werden sie dokumentiert; der Private-Chip blendet
sie aus, wenn man sie nicht sehen will.
- **`init` ist der Konstruktor** und bekommt einen eigenen Abschnitt vor
den Methoden.
Siehe [DocBox-API-Referenz](docbox.md) für die Konfiguration und
[ColdBox-Ausgabebeispiel](coldbox-example.md) für das, was der
ColdBox-Verb aus demselben Projekt macht.