diff options
author | Kohei Yoshida <kohei.yoshida@collabora.com> | 2014-06-25 20:02:59 -0400 |
---|---|---|
committer | Kohei Yoshida <kohei.yoshida@collabora.com> | 2014-06-25 20:12:46 -0400 |
commit | 78751ce780f18811fe2e878ba10be18d55c58e4d (patch) | |
tree | eb6855ab860c37417c6b44c8877ede5776bf00db | |
parent | 7847962863c7c2c23c7421be2b046c20c381916b (diff) |
Add class descriptions. These two classes' roles were not very clear.
Change-Id: Ib45c9037f2c4b3ee5bfed79f3c93e5020bac477b
-rw-r--r-- | chart2/source/inc/CachedDataSequence.hxx | 3 | ||||
-rw-r--r-- | chart2/source/inc/UncachedDataSequence.hxx | 10 |
2 files changed, 13 insertions, 0 deletions
diff --git a/chart2/source/inc/CachedDataSequence.hxx b/chart2/source/inc/CachedDataSequence.hxx index e4c9d80f407f..243eea5d12bc 100644 --- a/chart2/source/inc/CachedDataSequence.hxx +++ b/chart2/source/inc/CachedDataSequence.hxx @@ -56,6 +56,9 @@ typedef ::cppu::WeakComponentImplHelper7< CachedDataSequence_Base; } +/** + * This sequence object does store actual values within, hence "cached". + */ class CachedDataSequence : public ::comphelper::OMutexAndBroadcastHelper, public ::comphelper::OPropertyContainer, diff --git a/chart2/source/inc/UncachedDataSequence.hxx b/chart2/source/inc/UncachedDataSequence.hxx index 2d31d9779d3f..a87b798ceed0 100644 --- a/chart2/source/inc/UncachedDataSequence.hxx +++ b/chart2/source/inc/UncachedDataSequence.hxx @@ -61,6 +61,16 @@ typedef ::cppu::WeakComponentImplHelper8< UncachedDataSequence_Base; } +/** + * This sequence object does NOT store actual sequence data. Instead, it + * references a column inside the internal data table (represented by class + * InternalData) via range representation string. The range representation + * string ends with a numeric value that indicates the column index within + * the internal data table. + * + * <p>A range representation can be either '0', '1', '2', ..., or 'label 1', + * 'label 2', ....</p> + */ class UncachedDataSequence : public ::comphelper::OMutexAndBroadcastHelper, public ::comphelper::OPropertyContainer, |