From dd47eee1a0f300e63ad8be95fa2c7e87b3b824c5 Mon Sep 17 00:00:00 2001 From: Pino Toscano Date: Mon, 31 Oct 2005 11:40:36 +0000 Subject: [PATCH] more header cleanup; apidox fixes svn path=/trunk/KDE/kdeedu/libkdeedu/; revision=476050 --- kdeeduplot/kplotaxis.cpp | 3 -- kdeeduplot/kplotaxis.h | 80 +++++++++++++++++++++++++------------- kdeeduplot/kplotobject.h | 4 +- kdeeduplot/kplotwidget.cpp | 2 + kdeeduplot/kplotwidget.h | 3 +- 5 files changed, 59 insertions(+), 33 deletions(-) diff --git a/kdeeduplot/kplotaxis.cpp b/kdeeduplot/kplotaxis.cpp index 0099e0c..b81552f 100644 --- a/kdeeduplot/kplotaxis.cpp +++ b/kdeeduplot/kplotaxis.cpp @@ -15,9 +15,6 @@ * * ***************************************************************************/ -#include -#include -#include #include "kplotaxis.h" KPlotAxis::KPlotAxis() : m_visible(true), m_labelFieldWidth(0), m_labelFmt('g'), diff --git a/kdeeduplot/kplotaxis.h b/kdeeduplot/kplotaxis.h index fb7f3f4..e5cce98 100644 --- a/kdeeduplot/kplotaxis.h +++ b/kdeeduplot/kplotaxis.h @@ -18,59 +18,87 @@ #ifndef KPLOTAXIS_H #define KPLOTAXIS_H -#include - -/**class KPlotAxis - *@short Contains all data for drawing an axis including format specification axis labels. - *@author Andreas Nicolai - *@version 1.0 - */ +#include + +#include + +/** + * @short Axis for KPlotWidget + * + * Contains all data for drawing an axis including format specification axis labels. + * + * @author Andreas Nicolai + * @version 1.0 + */ class KDE_EXPORT KPlotAxis { public: - /**@short Default constructor, creates a default axis. */ + /** + * Default constructor, creates a default axis. + */ KPlotAxis(); - - /**@short Constructor, constructs a labeled axis. */ + /** + * Constructor, constructs an axis with the label @p label. + */ KPlotAxis(const QString& label); - /**@short Destructor. */ + /** + * Destructor. + */ virtual ~KPlotAxis() {} - /**@short Returns whether the axis is visible or not. */ + /** + * Returns whether the axis is visible or not. + */ virtual bool isVisible() const { return m_visible; } - /**@short Sets the "visible" property of the axis. */ + /** + * Sets the "visible" property of the axis. + */ virtual void setVisible(bool visible) { m_visible = visible; } - /**@short Shows the axis (axis will be shown at next update of plot widget). */ + /** + * Shows the axis (axis will be shown at next update of plot widget). + */ virtual void show() { m_visible = true; } - /**@short Hides the axis (axis will be hidden at next update of plot widget). */ + /** + * Hides the axis (axis will be hidden at next update of plot widget). + */ virtual void hide() { m_visible = false; } - /**@short Sets the axis label. - *@param label A short string describing the data plotted on the axis. - *Set the label to an empty string to omit the axis label. - */ + /** + * Sets the axis label. + * Set the label to an empty string to omit the axis label. + * @param label a string describing the data plotted on the axis. + */ virtual void setLabel( const QString& label ) { m_label = label; } - /**@short Returns the axis label. */ + /** + * Returns the axis label. + */ virtual QString label() const { return m_label; } - /**@short Set the number format for the tick labels, see QString::arg() for - description of arguments. - */ + /** + * Set the number format for the tick labels, see QString::arg() for + * description of arguments. + */ virtual void setLabelFormat(int fieldWidth, char fmt = 'g', int prec=-1) { m_labelFieldWidth = fieldWidth; m_labelFmt = fmt; m_labelPrec = prec; } - /**@short Returns the field width of the tick labels. */ + /** + * Returns the field width of the tick labels. + */ virtual int labelFieldWidth() const { return m_labelFieldWidth; } - /**@short Returns the number format of the tick labels. */ + /** + * Returns the number format of the tick labels. + */ virtual char labelFmt() const { return m_labelFmt; } - /**@short Returns the number precision of the tick labels. */ + /** + * short Returns the number precision of the tick labels. + */ virtual int labelPrec() const { return m_labelPrec; } private: diff --git a/kdeeduplot/kplotobject.h b/kdeeduplot/kplotobject.h index 86593f4..05e669b 100644 --- a/kdeeduplot/kplotobject.h +++ b/kdeeduplot/kplotobject.h @@ -31,7 +31,7 @@ * @author Jason Harris * @version 1.0 * Each KPlotObject consists of a list of QPoints, an object type, a color, a size, - * and a QString name. An additional integer (param) specifies something further + * and a name. An additional integer (param) specifies something further * about the object's appearance, depending on its type. There is a draw function * for plotting the object on a KPlotWidget's QPainter. */ @@ -67,7 +67,7 @@ public: KPlotObject( const QString &name, const QColor &color, PTYPE otype, unsigned int size=2, unsigned int param=0 ); /** - * Destructor (empty) + * Destructor. */ ~KPlotObject(); diff --git a/kdeeduplot/kplotwidget.cpp b/kdeeduplot/kplotwidget.cpp index c17e9a5..9a1855b 100644 --- a/kdeeduplot/kplotwidget.cpp +++ b/kdeeduplot/kplotwidget.cpp @@ -25,6 +25,8 @@ #include "kplotwidget.h" #include "kplotwidget.moc" +#include "kplotobject.h" + KPlotWidget::KPlotWidget( double x1, double x2, double y1, double y2, QWidget *parent ) : QWidget( parent, Qt::WNoAutoErase ), dXtick(0.0), dYtick(0.0), diff --git a/kdeeduplot/kplotwidget.h b/kdeeduplot/kplotwidget.h index 5e62aae..2b46576 100644 --- a/kdeeduplot/kplotwidget.h +++ b/kdeeduplot/kplotwidget.h @@ -22,7 +22,6 @@ #include #include #include -#include "kplotobject.h" #include "kplotaxis.h" #define BIGTICKSIZE 10 @@ -31,6 +30,7 @@ #define YPADDING 20 class QPixmap; +class KPlotObject; /** * @class KPlotWidget @@ -55,7 +55,6 @@ public: * @param y1 the minimum Y value in data units * @param y2 the maximum Y value in data units * @param parent the parent widget - * @param name name label for the KPlotWidget */ KPlotWidget( double x1=0.0, double x2=1.0, double y1=0.0, double y2=1.0, QWidget *parent=0 ); -- 2.47.3