From 42c7df49439ac80e671265fdfe198350e32c8b20 Mon Sep 17 00:00:00 2001 From: Hannu Lyytikainen Date: Tue, 23 Jan 2018 12:39:43 +0200 Subject: [PATCH] Add component comments Add information to FieldGroupCheckbox and PropertyGroup about the relation between the two components. --- src/components/FieldGroupCheckbox/FieldGroupCheckbox.js | 9 +++++++++ src/components/PropertyGroup/PropertyGroup.js | 8 ++++++++ 2 files changed, 17 insertions(+) diff --git a/src/components/FieldGroupCheckbox/FieldGroupCheckbox.js b/src/components/FieldGroupCheckbox/FieldGroupCheckbox.js index 60310cad..9fff4927 100644 --- a/src/components/FieldGroupCheckbox/FieldGroupCheckbox.js +++ b/src/components/FieldGroupCheckbox/FieldGroupCheckbox.js @@ -1,3 +1,12 @@ +/* + * Renders a group of checkboxes that can be used to select + * multiple values from a set of options. + * + * The corresponding component when rendering the selected + * values is PropertyGroup. + * + */ + import React, { Component } from 'react'; import PropTypes from 'prop-types'; import classNames from 'classnames'; diff --git a/src/components/PropertyGroup/PropertyGroup.js b/src/components/PropertyGroup/PropertyGroup.js index 55f80483..a41f6a62 100644 --- a/src/components/PropertyGroup/PropertyGroup.js +++ b/src/components/PropertyGroup/PropertyGroup.js @@ -1,3 +1,11 @@ +/* + * Renders a set of options with selected and non-selected values. + * + * The corresponding component when selecting the values is + * FieldGroupCheckbox. + * + */ + import React from 'react'; import PropTypes from 'prop-types'; import classNames from 'classnames';