Skip to content

Commit 6b4eb4d

Browse files
committed
feat: improve function signature format in C++ API doc
1 parent 112c91f commit 6b4eb4d

File tree

149 files changed

+1399
-2556
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

149 files changed

+1399
-2556
lines changed

content/reference/cpp/action_form.mdx

Lines changed: 18 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: "ActionForm"
44

55
## <code className="doc-symbol doc-symbol-class"/> endstone::ActionForm
66

7-
Bases: [`endstone::Form`](classendstone_1_1_form.md)
7+
Bases: [`endstone::Form`](form)
88

99

1010

@@ -100,26 +100,26 @@ Bases: [`endstone::Form`](classendstone_1_1_form.md)
100100
### <code className="doc-symbol doc-symbol-typedef"/> Control [#Control]
101101

102102
```cpp
103-
using endstone::ActionForm::Control = std::variant<Button, Divider, Header, Label>;
103+
using endstone::ActionForm::Control =
104+
std::variant<Button, Divider, Header, Label>;
104105
```
105106
### <code className="doc-symbol doc-symbol-typedef"/> OnSubmitCallback [#OnSubmitCallback]
106107

107108
```cpp
108-
using endstone::ActionForm::OnSubmitCallback = std::function<void(Player *, int)>;
109+
using endstone::ActionForm::OnSubmitCallback =
110+
std::function<void(Player *, int)>;
109111
```
110112
### <code className="doc-symbol doc-symbol-function"/> ActionForm [#ActionForm]
111113

112114
```cpp
113-
explicit endstone::ActionForm::ActionForm () = default
115+
ActionForm() = default
114116
```
115117
### <code className="doc-symbol doc-symbol-function"/> addButton [#addButton]
116118

117119
```cpp
118-
inline ActionForm & endstone::ActionForm::addButton (
119-
const Message & text,
120-
const std::optional< std::string > & icon=std::nullopt,
121-
Button::OnClickCallback on_click={}
122-
)
120+
ActionForm &addButton(const Message &text,
121+
const std::optional<std::string> &icon = std::nullopt,
122+
Button::OnClickCallback on_click = {})
123123
```
124124

125125
Adds a button to the form.
@@ -149,7 +149,7 @@ A reference to the current form.
149149
### <code className="doc-symbol doc-symbol-function"/> addDivider [#addDivider]
150150

151151
```cpp
152-
inline ActionForm & endstone::ActionForm::addDivider ()
152+
ActionForm &addDivider()
153153
```
154154

155155
Adds a divider to the form.
@@ -170,9 +170,7 @@ A reference to the current form.
170170
### <code className="doc-symbol doc-symbol-function"/> addHeader [#addHeader]
171171

172172
```cpp
173-
inline ActionForm & endstone::ActionForm::addHeader (
174-
const Message & text
175-
)
173+
ActionForm &addHeader(const Message &text)
176174
```
177175
178176
Adds a header to the form.
@@ -200,9 +198,7 @@ A reference to the current form.
200198
### <code className="doc-symbol doc-symbol-function"/> addLabel [#addLabel]
201199
202200
```cpp
203-
inline ActionForm & endstone::ActionForm::addLabel (
204-
const Message & text
205-
)
201+
ActionForm &addLabel(const Message &text)
206202
```
207203

208204
Adds a label to the form.
@@ -230,7 +226,7 @@ A reference to the current form.
230226
### <code className="doc-symbol doc-symbol-function"/> getContent [#getContent]
231227

232228
```cpp
233-
inline Message endstone::ActionForm::getContent () const
229+
Message getContent() const
234230
```
235231

236232
Get the content of the form.
@@ -251,7 +247,7 @@ The content of the form.
251247
### <code className="doc-symbol doc-symbol-function"/> getControls [#getControls]
252248

253249
```cpp
254-
inline const std::vector< Control > & endstone::ActionForm::getControls () const
250+
const std::vector<Control> &getControls() const
255251
```
256252

257253
Get the controls of the action form.
@@ -272,7 +268,7 @@ A list of controls in the action form.
272268
### <code className="doc-symbol doc-symbol-function"/> getOnSubmit [#getOnSubmit]
273269

274270
```cpp
275-
inline OnSubmitCallback endstone::ActionForm::getOnSubmit () const
271+
OnSubmitCallback getOnSubmit() const
276272
```
277273

278274
Gets the on submit callback of the form.
@@ -293,9 +289,7 @@ The on submit callback of the form.
293289
### <code className="doc-symbol doc-symbol-function"/> setContent [#setContent]
294290

295291
```cpp
296-
inline ActionForm & endstone::ActionForm::setContent (
297-
Message text
298-
)
292+
ActionForm &setContent(Message text)
299293
```
300294
301295
Set the content of the form.
@@ -323,9 +317,7 @@ A reference to the current form.
323317
### <code className="doc-symbol doc-symbol-function"/> setControls [#setControls]
324318
325319
```cpp
326-
inline ActionForm & endstone::ActionForm::setControls (
327-
const std::vector< Control > & controls
328-
)
320+
ActionForm &setControls(const std::vector<Control> &controls)
329321
```
330322

331323
Set the controls of the action form.
@@ -353,9 +345,7 @@ A reference to the current form.
353345
### <code className="doc-symbol doc-symbol-function"/> setOnSubmit [#setOnSubmit]
354346

355347
```cpp
356-
inline ActionForm & endstone::ActionForm::setOnSubmit (
357-
OnSubmitCallback on_submit
358-
)
348+
ActionForm &setOnSubmit(OnSubmitCallback on_submit)
359349
```
360350
361351
Sets the on submit callback of the form.

0 commit comments

Comments
 (0)