Update typedoc

aehrc · May 23, 2024 · ebb86e2 · ebb86e2
1 parent 7125485
commit ebb86e2
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/documentation/docs/api/smart-forms-renderer/functions/RendererThemeProvider.md b/documentation/docs/api/smart-forms-renderer/functions/RendererThemeProvider.md
@@ -2,7 +2,7 @@
 
 > **RendererThemeProvider**(`__namedParameters`): `Element`
 
-Default Material UI theme used by the renderer. You can customise your own theme by defining a new ThemeProvider.
+Default theme used by the renderer using Material UI. You can customise your own theme by defining a new ThemeProvider.
 
 ## Parameters
 

diff --git a/...ation/docs/api/smart-forms-renderer/functions/removeEmptyAnswersFromResponse.md b/...ation/docs/api/smart-forms-renderer/functions/removeEmptyAnswersFromResponse.md
@@ -2,8 +2,9 @@
 
 > **removeEmptyAnswersFromResponse**(`questionnaire`, `questionnaireResponse`): `QuestionnaireResponse`
 
-Remove all hidden answers from the filled QuestionnaireResponse.
+Remove all empty/hidden answers from the filled QuestionnaireResponse.
 This takes into account enableWhens, enableWhenExpressions, items without item.answer, empty item.answer arrays and empty strings.
+This does not remove items that are hidden by the http://hl7.org/fhir/StructureDefinition/questionnaire-hidden extension.
 
 ## Parameters
 

diff --git a/documentation/docs/api/smart-forms-renderer/index.md b/documentation/docs/api/smart-forms-renderer/index.md
@@ -43,7 +43,7 @@
 | [GridGroup](functions/GridGroup.md) | Main component to render a Group Grid (grid) Questionnaire item. |
 | [GroupTable](functions/GroupTable.md) | Main component to render a Group Table (gtable) Questionnaire item. |
 | [InitialiseFormWrapperForStorybook](functions/InitialiseFormWrapperForStorybook.md) | This is a one-to-one replacement for the SmartFormsRenderer for demo purposes. |
-| [RendererThemeProvider](functions/RendererThemeProvider.md) | Default Material UI theme used by the renderer. You can customise your own theme by defining a new ThemeProvider. |
+| [RendererThemeProvider](functions/RendererThemeProvider.md) | Default theme used by the renderer using Material UI. You can customise your own theme by defining a new ThemeProvider. |
 | [RepeatGroup](functions/RepeatGroup.md) | Main component to render a repeating, group Questionnaire item. |
 | [RepeatItem](functions/RepeatItem.md) | Main component to render a repeating, non-group Questionnaire item. |
 | [SingleItem](functions/SingleItem.md) | Main component to render a repeating, non-group Questionnaire item. |
@@ -56,7 +56,7 @@
 | [isRepeatItemAndNotCheckbox](functions/isRepeatItemAndNotCheckbox.md) | Check if qItem is a repeat item AND if it isn't a checkbox item |
 | [isSpecificItemControl](functions/isSpecificItemControl.md) | Check if the extension has an itemControl code equal to the given itemControlCode |
 | [parseFhirDateToDisplayDate](functions/parseFhirDateToDisplayDate.md) | Parse a FHIR date string to a date to be consumed and displayed by the DateItem component. |
-| [removeEmptyAnswersFromResponse](functions/removeEmptyAnswersFromResponse.md) | Remove all hidden answers from the filled QuestionnaireResponse. |
+| [removeEmptyAnswersFromResponse](functions/removeEmptyAnswersFromResponse.md) | Remove all empty/hidden answers from the filled QuestionnaireResponse. |
 | [repopulateResponse](functions/repopulateResponse.md) | Re-populate checked items in the re-population dialog into the current QuestionnaireResponse |
 | [useBuildForm](functions/useBuildForm.md) | React hook wrapping around the buildForm() function to build a form from a questionnaire and an optional QuestionnaireResponse. |
 | [useHidden](functions/useHidden.md) | React hook to determine if a QuestionnaireItem is hidden via item.hidden, enableWhens, enableWhenExpressions. |