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

List:       kde-commits
Subject:    branches/work/koffice-essen/libs/odf
From:       Carlos Licea <carlos_licea () hotmail ! com>
Date:       2010-11-10 2:08:14
Message-ID: 20101110020814.B188CAC8A1 () svn ! kde ! org
[Download RAW message or body]

SVN commit 1194892 by clicea:

Add some stub of documentation.

 M  +13 -5     KoCell.h  
 M  +7 -0      KoCellChild.h  
 M  +6 -0      KoCellStyle.h  
 M  +24 -0     KoColumnStyle.h  
 U             KoRawCellChild.h  
 M  +6 -0      KoRowStyle.h  
 M  +7 -0      KoStyle.h  
 M  +7 -0      KoTableStyle.h  


--- branches/work/koffice-essen/libs/odf/KoCell.h #1194891:1194892
@@ -45,10 +45,6 @@
 public:
     ~KoCell();
 
-<<<<<<< HEAD
-    void setStyle(KoCellStyle* style);
-    KoCellStyle* style() const;
-=======
     /**
      * Set the this Cell style to the given style.
      */
@@ -59,11 +55,23 @@
      * It's null if no style has been set.
      */
     KoCellStyle::Ptr style() const;
->>>>>>> c56441c... Fix KoCell.
 
+    /**
+     * Sets the value as defined by element office:value of ODF.
+     * \see ODF1.2 office:value  §19.386.
+     */
     void setValue(KoCellValue* value);
     KoCellValue* value() const;
 
+    /**
+     * A \class KoCellChild represents all the items that can be 
+     * contained inside a KoCell.
+     * \see ODF1.2 table:table-cell  §9.1.4
+     * 
+     * \note The cell takes ownership of the given KoCellChild.
+     * \note The order in which the elements are written to ODF
+     * is the same in which they were inserted.
+     */
     void appendChild(KoCellChild* child);
 
     /**
--- branches/work/koffice-essen/libs/odf/KoCellChild.h #1194891:1194892
@@ -23,6 +23,13 @@
 class KoXmlWriter;
 class KoGenStyles;
 
+/**
+ * A \class KoCellChild represents all the elements that can be contained
+ * inside a Cell.
+ * 
+ * \see ODF1.2 table:table-cell  §9.1.4
+ */
+
 class KoCellChild
 {
     friend class KoCell;
--- branches/work/koffice-essen/libs/odf/KoCellStyle.h #1194891:1194892
@@ -22,6 +22,12 @@
 #include "KoStyle.h"
 #include "KoBorder.h"
 
+/**
+ * A \class KoCellStyle represents a style of a cell to be applied to one or more cells.
+ * 
+ * As all the styles it can be shared
+ */
+
 class KoCellStyle : public KoStyle
 {
 public:
--- branches/work/koffice-essen/libs/odf/KoColumnStyle.h #1194891:1194892
@@ -1,3 +1,21 @@
+/*
+ *  Copyright (c) 2010 Carlos Licea <carlos@kdab.com>
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU Lesser General Public License as published
+ *  by the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+
 #ifndef KOCOLUMNSTYLE_H
 #define KOCOLUMNSTYLE_H
 
@@ -3,4 +21,10 @@
 #include "KoStyle.h"
 
+/**
+ * A \class KoColumnStyle represents a style to be applied to one or more columns.
+ * 
+ * As all the styles it can be shared
+ */
+
 class KoColumnStyle : public KoStyle
 {
--- branches/work/koffice-essen/libs/odf/KoRowStyle.h #1194891:1194892
@@ -21,6 +21,12 @@
 
 #include "KoStyle.h"
 
+/**
+ * A \class KoRowStyle represents a style of a row to be applied to one or more row.
+ * 
+ * As all the styles it can be shared
+ */
+
 class KoRowStyle : public KoStyle
 {
 public:
--- branches/work/koffice-essen/libs/odf/KoStyle.h #1194891:1194892
@@ -7,6 +7,13 @@
 #include <QString>
 #include <QSharedPointer>
 
+/**
+ * A \class KoStyle is the base for all of the styles used in KoOdf.
+ * Allows to easily share the styles amoung different compononents.
+ * 
+ * As all the styles it can be shared
+ **/
+
 class KoStyle
 {
 public:
--- branches/work/koffice-essen/libs/odf/KoTableStyle.h #1194891:1194892
@@ -21,6 +21,13 @@
 
 #include "KoStyle.h"
 
+/**
+ * A \class KoTableStyle represents a style for a Table in
+ * a ODF document.
+ * 
+ * As all the styles it can be shared. 
+ **/
+
 class KoTableStyle : public KoStyle
 {
 public:
[prev in list] [next in list] [prev in thread] [next in thread]