[fondue-commits] [SCM] Fondue Font Editor branch, master, updated. 1b8055ebf3f12c2c8411badf252986e1cd807bf0

[Eugeniy Meshcheryakov]

The following commit has been merged in the master branch:
commit 505dbe33d58fce331c7229524d8cb60db05fdf46
Author: Eugeniy Meshcheryakov <eugen at debian.org>
Date:   Fri Aug 8 17:50:47 2008 +0200

    document some ttf-related classes

diff --git a/filters/ttfexportfilter.cxx b/filters/ttfexportfilter.cxx
index 28fff18..827f6cc 100644
--- a/filters/ttfexportfilter.cxx
+++ b/filters/ttfexportfilter.cxx
@@ -73,6 +73,7 @@ private:
  * \class TTFExportFilter ttfexportfilter.h
  * TrueType export filter.
  * \ingroup export_filters
+ * \ingroup ttf
  */
 
 /** \copydoc ExportFilterBase::menuName() const
diff --git a/nongui/ttfdecode.cxx b/nongui/ttfdecode.cxx
index fd648ff..4bf132b 100644
--- a/nongui/ttfdecode.cxx
+++ b/nongui/ttfdecode.cxx
@@ -13,13 +13,20 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
+#include "ttfdecode.h"
 #include <QByteArray>
 #include <QDataStream>
 #include <QtEndian>
 #include <QDebug>
 
-#include "ttfdecode.h"
+/** \class TTInstructionsDecoder ttfdecode.h
+ * Class for disassembling TrueType instructions
+ * \ingroup ttf
+ */
 
+/** Decodes one instruction and returns its textual presentation.
+ * Returns null string on error.
+ */
 QByteArray TTInstructionsDecoder::getLine()
 {
 	quint8 op;
@@ -44,6 +51,10 @@ QByteArray TTInstructionsDecoder::getLine()
 	}
 }
 
+/** Decodes all instructions and returns textual presentation.
+ * Each instruction occupies separate line.
+ * Returns null string on error.
+ */
 QByteArray TTInstructionsDecoder::getAllLines()
 {
 	QByteArray ret;
diff --git a/nongui/ttfdecode.h b/nongui/ttfdecode.h
index 129e9c8..f726904 100644
--- a/nongui/ttfdecode.h
+++ b/nongui/ttfdecode.h
@@ -23,9 +23,14 @@ class QIODevice;
 class TTInstructionsDecoder {
 public:
 	enum Status {NoError, EndOfData, Error};
+	/** Constructs TTInstructionsDecoder.
+	 * Instructions will be read from a \a device.
+	 */
 	TTInstructionsDecoder(QIODevice *device) {this->device = device; m_status = NoError;}
 	QByteArray getLine();
 	QByteArray getAllLines();
+	/** Returns result of encoding.
+	 */
 	Status status() const {return m_status;}
 private:
 	QIODevice *device;
diff --git a/nongui/ttfencode.cxx b/nongui/ttfencode.cxx
index 8d207aa..5735235 100644
--- a/nongui/ttfencode.cxx
+++ b/nongui/ttfencode.cxx
@@ -20,12 +20,31 @@
 #include <QDebug>
 #include <QtEndian>
 
+/**
+ * \defgroup ttf TrueType Related Classes
+ */
+
+/**
+ * \class TTInstructionsEncoder ttfencode.h
+ * Class for compiling TrueType instructions.
+ * \ingroup ttf
+ */
+
+
+/**
+ * Constructs TTInstructionsEncoder.
+ * Sets \a input as input string.
+ */
 TTInstructionsEncoder::TTInstructionsEncoder(const QString &input) :
 	m_status(NoError), m_input(input), inputOffset(0), m_dataWritten(false)
 {
 
 }
 
+/**
+ * Compiles instructions and writes them into \a output device.
+ * Returns true on success.
+ */
 // TODO check for unexpected end of data
 bool TTInstructionsEncoder::encode(QIODevice *output)
 {
diff --git a/nongui/ttfencode.h b/nongui/ttfencode.h
index a016995..1f23418 100644
--- a/nongui/ttfencode.h
+++ b/nongui/ttfencode.h
@@ -24,8 +24,10 @@ public:
 	enum Status {NoError, SyntaxError, IOError};
 	TTInstructionsEncoder(const QString &input);
 	bool encode(QIODevice *output = 0);
+	/** Returns result of encoding.
+	 */
 	Status status() const {return m_status;}
-	/** returns true if input contained any instructions
+	/** Returns true if input contained any instructions.
 	 */
 	bool hadInstructions() const {return m_dataWritten;}
 private:

-- 
Fondue Font Editor