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

Eugeniy Meshcheryakov eugen at debian.org
Fri Aug 8 20:46:15 UTC 2008


The following commit has been merged in the master branch:
commit d5a3f09f4c85fb557ee969a4db30ac3fb3f98126
Author: Eugeniy Meshcheryakov <eugen at debian.org>
Date:   Fri Aug 8 20:46:33 2008 +0200

    cleanup comments

diff --git a/nongui/cvtentry.h b/nongui/cvtentry.h
index b4377b5..30b45dd 100644
--- a/nongui/cvtentry.h
+++ b/nongui/cvtentry.h
@@ -23,27 +23,25 @@
 class CVTEntry {
 public:
 	/** Construct a new entry.
-	 * Creates a new CVT entry with given value, name and comment.
+	 * Creates a new CVT entry with given \a value, \a name and \a comment.
 	 * All parameters are optional.
 	 */
 	CVTEntry(qint16 value = 0, QString variableName = QString(), QString comment = QString()) : m_value(value), m_variableName(variableName), m_comment(comment) {}
-	/** returns value for this entry.
-	 * @return value or 0 if not set.
-	 */
+	/** Returns value for this entry. */
 	qint16 value() const {return m_value;}
-	/** returns varable name for this entry.
-	 * @return variable name if set, empty string otherwise.
-	 */
+	/** Returns varable name for this entry. */
 	QString variableName() const {return m_variableName;}
-	/** returns comment for this entry.
-	 * @return comment or empty string if not set.
-	 */
+	/** Returns comment for this entry. */
 	QString comment() const {return m_comment;}
 
+	/** Sets new \a value. */
 	void setValue(qint16 value) {m_value = value;}
+	/** Sets new variable name. */
 	void setVariableName(const QString &name) {m_variableName = name;}
+	/** Sets new \a comment. */
 	void setComment(const QString &comment) {m_comment = comment;}
 
+	/** Returns true if this entry is equal to \a other. */
 	bool operator ==(const CVTEntry &other) const {return m_value == other.m_value && m_variableName == other.m_variableName && m_comment == other.m_comment;}
 private:
 	qint16 m_value;
diff --git a/nongui/fontdocument.cxx b/nongui/fontdocument.cxx
index 51555ff..1865e28 100644
--- a/nongui/fontdocument.cxx
+++ b/nongui/fontdocument.cxx
@@ -15,7 +15,11 @@
  */
 #include "fontdocument.h"
 
-/** Construct empty font document.
+/** \class FontDocument fontdocument.h
+ * Class that represents a font document.
+ */
+
+/** Construct an empty FontDocument.
  */
 FontDocument::FontDocument(QObject *parent) : QObject(parent),
 	m_documentChanged(false)
diff --git a/nongui/fontdocument.h b/nongui/fontdocument.h
index da979e4..bb131f6 100644
--- a/nongui/fontdocument.h
+++ b/nongui/fontdocument.h
@@ -28,8 +28,6 @@ Q_DECLARE_METATYPE(QList<Glyph *>)
 Q_DECLARE_METATYPE(CVTEntry)
 Q_DECLARE_METATYPE(QVector<CVTEntry>)
 
-/** Class that represents a font document.
- */
 class FontDocument : public QObject {
 	Q_OBJECT
 	Q_PROPERTY(QString copyright READ copyright WRITE setCopyright NOTIFY copyrightChanged)
diff --git a/nongui/fontdocumentreader.cxx b/nongui/fontdocumentreader.cxx
index 7b4d33a..9367f18 100644
--- a/nongui/fontdocumentreader.cxx
+++ b/nongui/fontdocumentreader.cxx
@@ -21,6 +21,19 @@
 #include "fontdocument.h"
 #include <QVariant>
 
+/** \class FontDocumentReader fontdocumentreader.h
+ * A class for reading a font document.
+ * @sa FontDocument
+ */
+
+/** \fn FontDocumentReader::FontDocumentReader(FontDocument*)
+ * Constructs reader for a given document.
+ * @param doc document to read.
+ */
+
+/** Read document from the given \a device.
+ * Returns true on succes.
+ */
 bool FontDocumentReader::read(QIODevice *device)
 {
 	setDevice(device);
diff --git a/nongui/fontdocumentreader.h b/nongui/fontdocumentreader.h
index 028b950..8ea922a 100644
--- a/nongui/fontdocumentreader.h
+++ b/nongui/fontdocumentreader.h
@@ -21,18 +21,9 @@
 class FontDocument;
 class Glyph;
 
-/** A class for reading a font document.
- * @sa FontDocument
- */
 class FontDocumentReader : public QXmlStreamReader {
 public:
-	/** Construct reader for a given document.
-	 * @param doc document to read.
-	 */
 	FontDocumentReader(FontDocument *doc) {this->doc = doc; c = QLocale::c();}
-	/** Read document from given device.
-	 * @return true on succes, flase on failure.
-	 */
 	bool read(QIODevice *device);
 private:
 	FontDocument *doc;
diff --git a/nongui/fontdocumentwriter.cxx b/nongui/fontdocumentwriter.cxx
index e0888bd..4da68a1 100644
--- a/nongui/fontdocumentwriter.cxx
+++ b/nongui/fontdocumentwriter.cxx
@@ -19,11 +19,21 @@
 #include "glyphcontour.h"
 #include "glyphreference.h"
 
+/** \class FontDocumentWriter fontdocumentwriter.h
+ * A class for writing of a font document.
+ * @sa FontDocument
+ */
+
+/** Construct writer for a given document.
+ * @param doc document to write.
+ */
 FontDocumentWriter::FontDocumentWriter(const FontDocument *doc)
 {
 	this->doc = doc;
 }
 
+/** Write the document to the \a device.
+ */
 bool FontDocumentWriter::write(QIODevice *device)
 {
 	setDevice(device);
diff --git a/nongui/fontdocumentwriter.h b/nongui/fontdocumentwriter.h
index ce55b33..c857c6c 100644
--- a/nongui/fontdocumentwriter.h
+++ b/nongui/fontdocumentwriter.h
@@ -22,17 +22,9 @@ class FontDocument;
 class Glyph;
 class OutlineItem;
 
-/** A class for writing of a font document.
- * @sa FontDocument
- */
 class FontDocumentWriter : public QXmlStreamWriter {
 public:
-	/** Construct writer for a given document.
-	 * @param doc document to write.
-	 */
 	FontDocumentWriter(const FontDocument *doc);
-	/** Write the document to the device.
-	 */
 	bool write(QIODevice *device);
 private:
 	const FontDocument *doc;
diff --git a/nongui/glyph.cxx b/nongui/glyph.cxx
index 4bf0791..fb3468d 100644
--- a/nongui/glyph.cxx
+++ b/nongui/glyph.cxx
@@ -19,6 +19,11 @@
 #include "fontdocument.h"
 #include <QtDebug>
 
+/** \class Glyph glyph.h
+ * %Glyph description.
+ * This class contains information about a glyph.
+ */
+
 /** Construct an empty glyph with given name.
  * @param name a name for the new glyph.
  */
diff --git a/nongui/glyph.h b/nongui/glyph.h
index 7f5e5e2..0f59954 100644
--- a/nongui/glyph.h
+++ b/nongui/glyph.h
@@ -22,9 +22,6 @@ class FontDocument;
 class GlyphReference;
 class GlyphContour;
 
-/** %Glyph description.
- * This class contains information about a glyph.
- */
 class Glyph : public QObject {
 	Q_OBJECT
 	Q_PROPERTY(QString glyphName READ glyphName WRITE setGlyphName NOTIFY glyphNameChanged)
diff --git a/nongui/ttfdecode.cxx b/nongui/ttfdecode.cxx
index 4bf132b..04363db 100644
--- a/nongui/ttfdecode.cxx
+++ b/nongui/ttfdecode.cxx
@@ -24,6 +24,15 @@
  * \ingroup ttf
  */
 
+/** \fn TTInstructionsDecoder::TTInstructionsDecoder(QIODevice*)
+ * Constructs TTInstructionsDecoder.
+ * Instructions will be read from a \a device.
+ */
+
+/** \fn TTInstructionsDecoder::Status TTInstructionsDecoder::status() const
+ * Returns result of encoding.
+ */
+
 /** Decodes one instruction and returns its textual presentation.
  * Returns null string on error.
  */
diff --git a/nongui/ttfdecode.h b/nongui/ttfdecode.h
index f726904..a97c688 100644
--- a/nongui/ttfdecode.h
+++ b/nongui/ttfdecode.h
@@ -23,14 +23,10 @@ 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 5735235..da4271e 100644
--- a/nongui/ttfencode.cxx
+++ b/nongui/ttfencode.cxx
@@ -30,6 +30,13 @@
  * \ingroup ttf
  */
 
+/** \fn TTInstructionsEncoder::Status TTInstructionsEncoder::status() const
+ * Returns result of encoding.
+ */
+
+/** \fn bool TTInstructionsEncoder::hadInstructions() const
+ * Returns true if input contained any instructions.
+ */
 
 /**
  * Constructs TTInstructionsEncoder.
diff --git a/nongui/ttfencode.h b/nongui/ttfencode.h
index 1f23418..2ec60f1 100644
--- a/nongui/ttfencode.h
+++ b/nongui/ttfencode.h
@@ -24,11 +24,7 @@ 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.
-	 */
 	bool hadInstructions() const {return m_dataWritten;}
 private:
 	Status m_status;

-- 
Fondue Font Editor



More information about the fondue-commits mailing list