[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    koffice/kspread (silent)
From:       Stefan Nikolaus <nikolaus4 () googlemail ! com>
Date:       2008-08-21 16:55:20
Message-ID: 1219337720.522223.27177.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 850499 by nikolaus:

Add at least minimal descriptions, so that the classes show up in the documentation.
SVN_SILENT


 M  +3 -0      ApplicationSettings.h  
 M  +3 -0      BindingManager.h  
 M  +3 -0      BindingModel.h  
 M  +4 -0      FunctionModule.h  
 M  +12 -0     Functions.h  
 M  +3 -0      NamedAreaManager.h  
 M  +4 -0      OdfLoadingContext.h  
 M  +4 -0      OdfSavingContext.h  
 M  +3 -0      PrintSettings.h  
 M  +3 -0      ShapeApplicationData.h  
 M  +3 -0      part/CellTool.h  
 M  +3 -0      part/CellToolFactory.h  
 M  +1 -1      ui/CellToolBase.h  


--- trunk/koffice/kspread/ApplicationSettings.h #850498:850499
@@ -31,6 +31,9 @@
 namespace KSpread
 {
 
+/**
+ * Visual settings.
+ */
 class KSPREAD_EXPORT ApplicationSettings : public QObject
 {
     Q_OBJECT
--- trunk/koffice/kspread/BindingManager.h #850498:850499
@@ -29,6 +29,9 @@
 class Map;
 class Region;
 
+/**
+ * Manages cell ranges acting as data sources.
+ */
 class BindingManager : public QObject
 {
     Q_OBJECT
--- trunk/koffice/kspread/BindingModel.h #850498:850499
@@ -29,6 +29,9 @@
 {
 class Binding;
 
+/**
+ * A model for a cell range acting as data source.
+ */
 class BindingModel : public QAbstractTableModel, public KoChart::ChartModel
 {
     Q_OBJECT
--- trunk/koffice/kspread/FunctionModule.h #850498:850499
@@ -27,6 +27,10 @@
 
 namespace KSpread
 {
+
+/**
+ * A function module.
+ */
 class KSPREAD_EXPORT FunctionModule : public QObject
 {
     Q_OBJECT
--- trunk/koffice/kspread/Functions.h #850498:850499
@@ -51,6 +51,9 @@
 
 typedef Value (*FunctionPtr)(valVector, ValueCalc *, FuncExtra *);
 
+/**
+ * A function pointer and context.
+ */
 class KSPREAD_EXPORT Function
 {
 public:
@@ -84,6 +87,9 @@
 
 enum ParameterType { KSpread_Int, KSpread_Float, KSpread_String, KSpread_Boolean, KSpread_Any };
 
+/**
+ * A function parameter.
+ */
 class KSPREAD_EXPORT FunctionParameter
 {
 public:
@@ -101,6 +107,9 @@
   bool m_range;
 };
 
+/**
+ * A function description.
+ */
 class KSPREAD_EXPORT FunctionDescription
 {
 public:
@@ -134,6 +143,9 @@
   QList<FunctionParameter> m_params;
 };
 
+/**
+ * The function repository.
+ */
 class KSPREAD_EXPORT FunctionRepository
 {
 public:
--- trunk/koffice/kspread/NamedAreaManager.h #850498:850499
@@ -39,6 +39,9 @@
 class Map;
 class Region;
 
+/**
+ * Manages named cell areas.
+ */
 class KSPREAD_EXPORT NamedAreaManager : public QObject
 {
     Q_OBJECT
--- trunk/koffice/kspread/OdfLoadingContext.h #850498:850499
@@ -27,6 +27,10 @@
 namespace KSpread
 {
 
+/**
+ * \ingroup OpenDocument
+ * Data used while loading.
+ */
 class OdfLoadingContext
 {
 public:
--- trunk/koffice/kspread/OdfSavingContext.h #850498:850499
@@ -34,6 +34,10 @@
 namespace KSpread
 {
 
+/**
+ * \ingroup OpenDocument
+ * Data used while saving.
+ */
 class OdfSavingContext
 {
 public:
--- trunk/koffice/kspread/PrintSettings.h #850498:850499
@@ -34,6 +34,9 @@
 {
 class Region;
 
+/**
+ * Settings used for printing.
+ */
 class KSPREAD_EXPORT PrintSettings
 {
 public:
--- trunk/koffice/kspread/ShapeApplicationData.h #850498:850499
@@ -25,6 +25,9 @@
 namespace KSpread
 {
 
+/**
+ * KSpread specific data attached to each shape.
+ */
 class ShapeApplicationData : public KoShapeApplicationData
 {
 public:
--- trunk/koffice/kspread/part/CellTool.h #850498:850499
@@ -27,6 +27,9 @@
 namespace KSpread
 {
 
+/**
+ * The tool to change cell ranges.
+ */
 class KSPREAD_EXPORT CellTool : public CellToolBase
 {
     Q_OBJECT
--- trunk/koffice/kspread/part/CellToolFactory.h #850498:850499
@@ -27,6 +27,9 @@
 namespace KSpread
 {
 
+/**
+ * The Factory, that creates a CellTool.
+ */
 class KSPREAD_EXPORT CellToolFactory : public KoToolFactory
 {
     Q_OBJECT
--- trunk/koffice/kspread/ui/CellToolBase.h #850498:850499
@@ -40,7 +40,7 @@
 class SheetView;
 
 /**
- * Base tool providing actions acting on cell ranges.
+ * Abstract tool providing actions acting on cell ranges.
  */
 class KSPREAD_EXPORT CellToolBase : public KoInteractionTool
 {
[prev in list] [next in list] [prev in thread] [next in thread]