diff --git a/docs/ff-concepts/adding-customization/custom-code.md b/docs/ff-concepts/adding-customization/custom-code.md index 5c96ba9d..5c26f9ea 100644 --- a/docs/ff-concepts/adding-customization/custom-code.md +++ b/docs/ff-concepts/adding-customization/custom-code.md @@ -243,6 +243,22 @@ Here's an example of an Action that returns a _nullable_ integer. ![return-value-actions.png](imgs/return-value-actions.png) +## Description + +You can add a [**Description**](../../intro/ff-ui/resource-hierarchy.md#resource-description) note on Custom Functions and Custom Actions to briefly explain their purpose, usage, or important details. This helps clarify what the function or action is intended for, making your project more understandable and maintainable—especially in libraries and collaborative environments. + +![adding-description-on-custom-function-action.avif](imgs/adding-description-on-custom-function-action.avif) + +You can view these descriptions as tooltips by hovering over the green note icon when selecting a Custom Function or Custom Action. + +![view-description-custom-function-and-custom-action](imgs/view-description-custom-function-and-custom-action.avif) + +:::tip +In the generated code, descriptions are added as comments before the function definition, and they also appear in the custom code editor. + +![description-in-custom-code](imgs/description-in-custom-code.avif) +::: + ## Adding a Pubspec Dependency To utilize community-built Flutter solutions in your FlutterFlow projects, you can add a "pubspec dependency". The **pubspec file** is the configuration file in Flutter projects that lists external packages or libraries, along with other project configurations. diff --git a/docs/ff-concepts/adding-customization/imgs/adding-description-on-custom-function-action.avif b/docs/ff-concepts/adding-customization/imgs/adding-description-on-custom-function-action.avif new file mode 100644 index 00000000..035d8f89 Binary files /dev/null and b/docs/ff-concepts/adding-customization/imgs/adding-description-on-custom-function-action.avif differ diff --git a/docs/ff-concepts/adding-customization/imgs/description-in-custom-code.avif b/docs/ff-concepts/adding-customization/imgs/description-in-custom-code.avif new file mode 100644 index 00000000..b17ae2e4 Binary files /dev/null and b/docs/ff-concepts/adding-customization/imgs/description-in-custom-code.avif differ diff --git a/docs/ff-concepts/adding-customization/imgs/view-description-custom-function-and-custom-action.avif b/docs/ff-concepts/adding-customization/imgs/view-description-custom-function-and-custom-action.avif new file mode 100644 index 00000000..eee94879 Binary files /dev/null and b/docs/ff-concepts/adding-customization/imgs/view-description-custom-function-and-custom-action.avif differ