Document sparkline related classes, functions and structs

No functional change.

Change-Id: I822c6a9d270dc582aaae2900f833843a0d6f8ddc
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/134651
Tested-by: Jenkins
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>

15 files changed, 22 insertions, 2 deletions

diff --git a/sc/inc/SparklineCell.hxx b/sc/inc/SparklineCell.hxx
index 0588646866c4..f048148ce4a0 100644
--- a/sc/inc/SparklineCell.hxx
+++ b/sc/inc/SparklineCell.hxx
@@ -16,6 +16,7 @@
 
 namespace sc
 {
+/** Hodler of a sparkline, that is connected to a cell specific */
 class SC_DLLPUBLIC SparklineCell
 {
 private:
diff --git a/sc/inc/SparklineData.hxx b/sc/inc/SparklineData.hxx
index 80cc8a0329c2..c004abbd73dc 100644
--- a/sc/inc/SparklineData.hxx
+++ b/sc/inc/SparklineData.hxx
@@ -15,6 +15,7 @@
 
 namespace sc
 {
+/** Data defining a sparkline - input data and output position */
 struct SC_DLLPUBLIC SparklineData
 {
     ScAddress maPosition;
@@ -34,6 +35,7 @@ enum class RangeOrientation
     Col
 };
 
+/** Determine the sparkline group orientation for the input data the output size */
 SC_DLLPUBLIC RangeOrientation calculateOrientation(sal_Int32 nOutputSize,
                                                    ScRange const& rInputRange);
 
diff --git a/sc/qa/unit/SparklineImportExportTest.cxx b/sc/qa/unit/SparklineImportExportTest.cxx
index d5d2c38b58c6..6d3f8a73931a 100644
--- a/sc/qa/unit/SparklineImportExportTest.cxx
+++ b/sc/qa/unit/SparklineImportExportTest.cxx
@@ -17,6 +17,7 @@
 
 using namespace css;
 
+/** Test import, export or roundtrip of sparklines for ODF and OOXML */
 class SparklineImportExportTest : public ScBootstrapFixture, public XmlTestTools
 {
 private:
diff --git a/sc/qa/unit/SparklineTest.cxx b/sc/qa/unit/SparklineTest.cxx
index 9c52ab1d1c65..ee104ef56356 100644
--- a/sc/qa/unit/SparklineTest.cxx
+++ b/sc/qa/unit/SparklineTest.cxx
@@ -19,6 +19,7 @@
 
 using namespace css;
 
+/** Test operation for sparklines, sparkline groups and attributes */
 class SparklineTest : public ScBootstrapFixture
 {
 private:
diff --git a/sc/source/filter/inc/SparklineFragment.hxx b/sc/source/filter/inc/SparklineFragment.hxx
index 6ed4bad49bc5..0d4e76e6b9a9 100644
--- a/sc/source/filter/inc/SparklineFragment.hxx
+++ b/sc/source/filter/inc/SparklineFragment.hxx
@@ -23,6 +23,7 @@ class AttributeList;
 
 namespace oox::xls
 {
+/** Transitional sparkline data */
 class Sparkline
 {
 public:
@@ -31,6 +32,7 @@ public:
     Sparkline() {}
 };
 
+/** Transitional sparkline group data */
 class SparklineGroup
 {
 private:
@@ -49,6 +51,7 @@ public:
     std::vector<Sparkline>& getSparklines() { return m_aSparklines; }
 };
 
+/** Handle import of the sparkline, sparkline group and attributes */
 class SparklineGroupsContext : public WorksheetContextBase
 {
 private:
diff --git a/sc/source/filter/inc/export/SparklineExt.hxx b/sc/source/filter/inc/export/SparklineExt.hxx
index 554fe9c7ec34..f2bff1c7d377 100644
--- a/sc/source/filter/inc/export/SparklineExt.hxx
+++ b/sc/source/filter/inc/export/SparklineExt.hxx
@@ -24,6 +24,7 @@
 
 namespace xcl::exp
 {
+/** Export for sparkline type of <ext> element - top sparkline element. */
 class SparklineExt : public XclExpExt
 {
 public:
@@ -42,6 +43,7 @@ public:
     XclExpExtType GetType() override { return XclExpExtSparklineType; }
 };
 
+/** Determines if sparklines needs to be exported and initiates the export. */
 class SparklineBuffer : public XclExpRecordBase, protected XclExpRoot
 {
 public:
diff --git a/sc/source/filter/xml/SparklineGroupsExport.hxx b/sc/source/filter/xml/SparklineGroupsExport.hxx
index b20fd8529574..9359413735dc 100644
--- a/sc/source/filter/xml/SparklineGroupsExport.hxx
+++ b/sc/source/filter/xml/SparklineGroupsExport.hxx
@@ -22,6 +22,7 @@ class ScXMLExport;
 
 namespace sc
 {
+/** Handle the export of sparkline groups and sparklines */
 class SparklineGroupsExport
 {
     ScXMLExport& m_rExport;
diff --git a/sc/source/filter/xml/SparklineGroupsImportContext.hxx b/sc/source/filter/xml/SparklineGroupsImportContext.hxx
index f643c1c054f7..b8161c96506d 100644
--- a/sc/source/filter/xml/SparklineGroupsImportContext.hxx
+++ b/sc/source/filter/xml/SparklineGroupsImportContext.hxx
@@ -24,12 +24,14 @@ namespace sc
 {
 class SparklineGroup;
 
+/** Transitional import data of a sparkline */
 struct SparklineImportData
 {
     ScAddress m_aAddress;
     ScRangeList m_aDataRangeList;
 };
 
+/** Handle the import of sparkline groups and sparklines */
 class SparklineGroupsImportContext : public ScXMLImportContext
 {
 private:
diff --git a/sc/source/ui/inc/SparklineDataRangeDialog.hxx b/sc/source/ui/inc/SparklineDataRangeDialog.hxx
index 41d882c8bc40..32d3ed035c71 100644
--- a/sc/source/ui/inc/SparklineDataRangeDialog.hxx
+++ b/sc/source/ui/inc/SparklineDataRangeDialog.hxx
@@ -20,6 +20,7 @@ class ColorListBox;
 
 namespace sc
 {
+/** Dialog to change input data range for a sparkline  */
 class SparklineDataRangeDialog : public ScAnyRefDlgController
 {
 private:
diff --git a/sc/source/ui/inc/SparklineDialog.hxx b/sc/source/ui/inc/SparklineDialog.hxx
index 8467f6d2ce11..f3f309c56832 100644
--- a/sc/source/ui/inc/SparklineDialog.hxx
+++ b/sc/source/ui/inc/SparklineDialog.hxx
@@ -20,6 +20,7 @@ class ColorListBox;
 
 namespace sc
 {
+/** Dialog to create or edit sparkline group attributes */
 class SparklineDialog : public ScAnyRefDlgController
 {
 private:
diff --git a/sc/source/ui/inc/SparklineShell.hxx b/sc/source/ui/inc/SparklineShell.hxx
index 11028dd8a461..912928d14923 100644
--- a/sc/source/ui/inc/SparklineShell.hxx
+++ b/sc/source/ui/inc/SparklineShell.hxx
@@ -19,6 +19,7 @@ class SfxModule;
 
 namespace sc
 {
+/** Shell to handle the sparkline context */
 class SparklineShell final : public SfxShell
 {
 public:
diff --git a/sc/source/ui/inc/reffact.hxx b/sc/source/ui/inc/reffact.hxx
index 1394418ffa85..d6c2b1d2c788 100644
--- a/sc/source/ui/inc/reffact.hxx
+++ b/sc/source/ui/inc/reffact.hxx
@@ -149,7 +149,7 @@ private:
 
 namespace sc
 {
-
+/** Wrapper for the sparkline properties dialog */
 class SparklineDialogWrapper :
     public ChildControllerWrapper<SID_SPARKLINE_DIALOG>
 {
@@ -157,6 +157,7 @@ private:
     SparklineDialogWrapper() = delete;
 };
 
+/** Wrapper for the sparkline data range dialog */
 class SparklineDataRangeDialogWrapper :
     public ChildControllerWrapper<SID_SPARKLINE_DATA_RANGE_DIALOG>
 {
diff --git a/sc/source/ui/inc/undo/UndoGroupSparklines.hxx b/sc/source/ui/inc/undo/UndoGroupSparklines.hxx
index 97bb3a9ee7ec..bc8324ba4799 100644
--- a/sc/source/ui/inc/undo/UndoGroupSparklines.hxx
+++ b/sc/source/ui/inc/undo/UndoGroupSparklines.hxx
@@ -15,6 +15,7 @@
 
 namespace sc
 {
+/** Previous sparkline group data, which is restored at Undo grupping */
 struct UndoGroupSparklinesData
 {
     UndoGroupSparklinesData(ScAddress const& rAddress, ScRangeList const& rDataRangeList,
@@ -30,7 +31,7 @@ struct UndoGroupSparklinesData
     std::shared_ptr<sc::SparklineGroup> m_pSparklineGroup;
 };
 
-/** Undo action for ungrouping sparklines */
+/** Undo action for grouping sparklines */
 class UndoGroupSparklines : public ScSimpleUndo
 {
 private:
diff --git a/sc/source/ui/inc/undo/UndoUngroupSparklines.hxx b/sc/source/ui/inc/undo/UndoUngroupSparklines.hxx
index 9f372f00e686..ce49d701e72b 100644
--- a/sc/source/ui/inc/undo/UndoUngroupSparklines.hxx
+++ b/sc/source/ui/inc/undo/UndoUngroupSparklines.hxx
@@ -15,6 +15,7 @@
 
 namespace sc
 {
+/** Previous sparkline group data, which is restored at undo ungroupping */
 struct SparklineUndoData
 {
     SparklineUndoData(ScAddress const& rAddress, ScRangeList const& rDataRangeList,
diff --git a/sc/source/ui/sparklines/SparklineAttributes.cxx b/sc/source/ui/sparklines/SparklineAttributes.cxx
index cbc8d369ded9..20b8bf6feee6 100644
--- a/sc/source/ui/sparklines/SparklineAttributes.cxx
+++ b/sc/source/ui/sparklines/SparklineAttributes.cxx
@@ -12,6 +12,7 @@
 
 namespace sc
 {
+/** Holder of sparkline attributes */
 class SparklineAttributes::Implementation
 {
 public: