BBCode in the Editor Help Window

Godot Version

4.2.1

Question

I’m writing documentation comments using Godot’s built-in documentation comment feature, and viewing the results in the editor help window.

On the GDScript documentation webpage, the section “BBCode and class reference” states the editor help window supports BBCode.

It mentions tables, but I couldn’t get tables to work. This is my BBCode for the table:

[table=3]
[cell]1[/cell][cell]2[/cell][cell]3[/cell]
[cell]4[/cell][cell]5[/cell][cell]6[/cell]
[cell]7[/cell][cell]8[/cell][cell]9[/cell]
[/table]

It works in a RichTextLabel node, so I think the table’s syntax and structure is correct, but it fails to render in the editor help window:

I’m not sure what I’ve done wrong, and I’m wondering if anyone else has encountered this issue? And if there is a solution?

I have found that editor docs are quite strict about the hash and space characters.

top-stuff (like tool or class_name, etc.)
<empty line>
##<space>Title
##
##<space>Introduction
##<space>continued..
##
##<space>Keep going.

Try that.

Hi dbat,

I got the text you provided to render in the editor help window, but I couldn’t get the table to work.

I added my table to your BBCode example, and included a line break on line3 ([br]). Code below:

## Title
##
## Introduction text[br]
## [table=3]
## [cell]1[/cell][cell]2[/cell][cell]3[/cell]
## [cell]4[/cell][cell]5[/cell][cell]6[/cell]
## [cell]7[/cell][cell]8[/cell][cell]9[/cell]
## [/table]
##

Thank you for helping me.

1 Like

I think only a small set of bbcode is available for the auto docs. The rest is for the rich text control: