MCPcopy Create free account
hub / github.com/URLab-Sim/UnrealRoboticsLab / _render_enum

Function _render_enum

Scripts/emit_docs.py:412–451  ·  view source on GitHub ↗
(enm: dict, class_map: dict)

Source from the content-addressed store, hash-verified

410
411
412def _render_enum(enm: dict, class_map: dict) -> str:
413 lines = []
414 name = enm.get('name', '')
415 brief = _clean_brief(enm.get('brief') or '')
416 desc = enm.get('description', '')
417 is_bp = enm.get('is_blueprint_type', False)
418
419 lines.append('---')
420 lines.append('tags:')
421 lines.append(' - Enum')
422 if is_bp:
423 lines.append(' - BlueprintType')
424 lines.append('---')
425
426 lines.append(f'# {name} *(Enum)*')
427 if brief:
428 lines.append(f'\n> {brief}\n')
429 if desc:
430 lines.append(f'{desc}\n')
431
432 lines.append('| Attribute | Value |')
433 lines.append('|---|---|')
434 lines.append(f'| UE Macro | `UENUM` |')
435 if is_bp:
436 lines.append('| Blueprint Type | ✅ Yes |')
437 lines.append('')
438
439 values = enm.get('values', [])
440 if values:
441 lines.append('## Values\n')
442 lines.append('| Name | Display Name | Description |')
443 lines.append('|---|---|---|')
444 for v in values:
445 vname = v.get('name', '')
446 dname = v.get('display_name', '') or vname
447 vbrief = _esc(_clean_brief(v.get('brief') or ''))
448 lines.append(f'| `{vname}` | {dname} | {vbrief} |')
449 lines.append('')
450
451 return '\n'.join(lines)
452
453
454# ──────────────────────────────────────────────────────────────────────────────

Callers 1

emit_docsFunction · 0.85

Calls 2

_clean_briefFunction · 0.85
_escFunction · 0.85

Tested by

no test coverage detected