Add some documentation to Line

1 files changed, 20 insertions, 0 deletions

diff --git a/src/line.h b/src/line.h
index a79abe4..79ea0c4 100644
--- a/src/line.h
+++ b/src/line.h
@@ -17,6 +17,8 @@
 #ifndef DIAGRAMCONNECTION_H
 #define DIAGRAMCONNECTION_H
 
+#include <QPolygonF>
+#include <QPainterPath>
 #include "diagramitem.h"
 #include "diagramdocument.h"
 class Connector;
@@ -47,22 +49,40 @@ public:
 	virtual void loadFromXml(QDomElement element, DiagramDocument *document = 0);
 	void saveToXml(QDomDocument doc, QDomElement element);
 
+	//! The path of the line
 	QPolygonF linePoints() const;
+
+	//! Set the path of the line
 	void setLinePoints(const QPolygonF &points);
 
+	//! The style of the line
 	Qt::PenStyle lineStyle() const;
+
+	//! Set the style of the line
 	void setLineStyle(Qt::PenStyle style);
 
+	//! Path of the start arrow
 	QPainterPath startArrow() const;
+
+	//! Set the path of the start arrow
 	void setStartArrow(const QPainterPath &path);
 
+	//! Should the start arrow be filled?
 	bool fillStartArrow() const;
+
+	//! Set whether the start arrow should be filled.
 	void setFillStartArrow(bool fill);
 
+	//! Path of the end arrow
 	QPainterPath endArrow() const;
+
+	//! Set the path of the end arrow
 	void setEndArrow(const QPainterPath &path);
 
+	//! Should the end arrow be filled?
 	bool fillEndArrow() const;
+
+	//! Set whether the end arrow should be filled.
 	void setFillEndArrow(bool fill);
 
 private: