Skip to content

Commit dcf4673

Browse files
committed
Document enums
1 parent 31f12a1 commit dcf4673

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

docs/_data/nav_docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
- id: classes-codegen-class-base
2222
- id: classes-codegen-interface
2323
- id: classes-codegen-class
24+
- id: classes-codegen-enum
2425

2526
# n title:, 1 items: per title:, n id: per items:
2627
# - title: A

docs/_docs/classes/codegen-enum.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
docid: classes-codegen-enum
3+
title: CodegenEnum
4+
layout: docs
5+
permalink: /docs/classes/CodegenEnum/
6+
---
7+
8+
A `CodegenInterface` is created with `$factory->codegenEnum($name, $type)`; allowable
9+
types are `string` or `int`.
10+
11+
Values are added to the enum with `->::addConst()` from `CodegenBaseClass`.
12+
13+
If you want an enum to be usable as its' base type, call `->setIsAs($base_type)`.

0 commit comments

Comments
 (0)