summaryrefslogtreecommitdiffstats
path: root/src/display
diff options
context:
space:
mode:
authorJon A. Cruz <jon@joncruz.org>2011-10-25 07:45:35 +0000
committerJon A. Cruz <jon@joncruz.org>2011-10-25 07:45:35 +0000
commit1a5d5d8a7e796035bc70d5c727d4d901dda50726 (patch)
treee15866e9b83d8948e6f7329193bbe4b6eefaa840 /src/display
parentcppcheck (diff)
downloadinkscape-1a5d5d8a7e796035bc70d5c727d4d901dda50726.tar.gz
inkscape-1a5d5d8a7e796035bc70d5c727d4d901dda50726.zip
Cleanup pass on documentation that was dumping garbage into doxygen output.
(bzr r10696)
Diffstat (limited to 'src/display')
-rw-r--r--src/display/canvas-temporary-item-list.h7
-rw-r--r--src/display/canvas-temporary-item.h7
-rw-r--r--src/display/curve.h7
-rw-r--r--src/display/grayscale.h9
-rw-r--r--src/display/nr-filter-utils.h8
-rw-r--r--src/display/snap-indicator.h6
-rw-r--r--src/display/sodipodi-ctrlrect.h5
-rw-r--r--src/display/sp-canvas-group.h8
-rw-r--r--src/display/sp-canvas-item.h6
-rw-r--r--src/display/sp-canvas.h6
10 files changed, 42 insertions, 27 deletions
diff --git a/src/display/canvas-temporary-item-list.h b/src/display/canvas-temporary-item-list.h
index 7a9f8b87a..d204c692f 100644
--- a/src/display/canvas-temporary-item-list.h
+++ b/src/display/canvas-temporary-item-list.h
@@ -1,9 +1,7 @@
#ifndef INKSCAPE_CANVAS_TEMPORARY_ITEM_LIST_H
#define INKSCAPE_CANVAS_TEMPORARY_ITEM_LIST_H
-/** \file
- * Provides a class that can contain active TemporaryItem's on a desktop
- *
+/*
* Authors:
* Johan Engelen
*
@@ -23,6 +21,9 @@ namespace Display {
class TemporaryItem;
+/**
+ * Provides a class that can contain active TemporaryItem's on a desktop.
+ */
class TemporaryItemList {
public:
TemporaryItemList(SPDesktop *desktop);
diff --git a/src/display/canvas-temporary-item.h b/src/display/canvas-temporary-item.h
index b73907bad..c8917b530 100644
--- a/src/display/canvas-temporary-item.h
+++ b/src/display/canvas-temporary-item.h
@@ -1,9 +1,7 @@
#ifndef INKSCAPE_CANVAS_TEMPORARY_ITEM_H
#define INKSCAPE_CANVAS_TEMPORARY_ITEM_H
-/** \file
- * Provides a class to put a canvasitem temporarily on-canvas.
- *
+/*
* Authors:
* Johan Engelen
*
@@ -22,6 +20,9 @@ struct SPCanvasItem;
namespace Inkscape {
namespace Display {
+/**
+ * Provides a class to put a canvasitem temporarily on-canvas.
+ */
class TemporaryItem {
public:
TemporaryItem(SPCanvasItem *item, guint lifetime, bool destroy_on_deselect = false);
diff --git a/src/display/curve.h b/src/display/curve.h
index ec828e674..4f129b542 100644
--- a/src/display/curve.h
+++ b/src/display/curve.h
@@ -1,9 +1,7 @@
#ifndef SEEN_DISPLAY_CURVE_H
#define SEEN_DISPLAY_CURVE_H
-/** \file
- * Wrapper around a Geom::PathVector objects.
- *
+/*
* Author:
* Lauris Kaplinski <lauris@kaplinski.com>
*
@@ -22,6 +20,9 @@
#include <boost/optional.hpp>
+/**
+ * Wrapper around a Geom::PathVector objects.
+ */
class SPCurve {
public:
/* Constructors */
diff --git a/src/display/grayscale.h b/src/display/grayscale.h
index fe0d75cad..18162e1f3 100644
--- a/src/display/grayscale.h
+++ b/src/display/grayscale.h
@@ -1,9 +1,7 @@
#ifndef SEEN_DISPLAY_GRAYSCALE_H
#define SEEN_DISPLAY_GRAYSCALE_H
-/** \file
- * Provide methods to calculate grayscale values (e.g. convert rgba value to grayscale rgba value)
- *
+/*
* Author:
* Johan Engelen <goejendaagh@zonnet.nl>
*
@@ -14,6 +12,9 @@
#include <gdk/gdk.h>
+/**
+ * Provide methods to calculate grayscale values (e.g. convert rgba value to grayscale rgba value).
+ */
namespace Grayscale {
guint32 process(guint32 rgba);
guint32 process(guchar r, guchar g, guchar b, guchar a);
@@ -22,7 +23,7 @@ namespace Grayscale {
bool activeDesktopIsGrayscale();
};
-#endif /* !SEEN_DISPLAY_GRAYSCALE_H */
+#endif // !SEEN_DISPLAY_GRAYSCALE_H
/*
Local Variables:
diff --git a/src/display/nr-filter-utils.h b/src/display/nr-filter-utils.h
index 4d2b06bd5..7e073168f 100644
--- a/src/display/nr-filter-utils.h
+++ b/src/display/nr-filter-utils.h
@@ -1,9 +1,11 @@
#ifndef __NR_FILTER_UTILS_H__
#define __NR_FILTER_UTILS_H__
-/** \file
- * filter utils. Definition of functions needed by several filters.
- *
+/**
+ * @file
+ * Definition of functions needed by several filters.
+ */
+/*
* Authors:
* Jean-Rene Reinhard <jr@komite.net>
*
diff --git a/src/display/snap-indicator.h b/src/display/snap-indicator.h
index da66d0033..30040d99c 100644
--- a/src/display/snap-indicator.h
+++ b/src/display/snap-indicator.h
@@ -1,9 +1,11 @@
#ifndef INKSCAPE_DISPLAY_SNAP_INDICATOR_H
#define INKSCAPE_DISPLAY_SNAP_INDICATOR_H
-/** \file
+/**
+ * @file
* Provides a class that shows a temporary indicator on the canvas of where the snap was, and what kind of snap
- *
+ */
+/*
* Authors:
* Johan Engelen
* Diederik van Lierop
diff --git a/src/display/sodipodi-ctrlrect.h b/src/display/sodipodi-ctrlrect.h
index a83c7bc38..05688e6b5 100644
--- a/src/display/sodipodi-ctrlrect.h
+++ b/src/display/sodipodi-ctrlrect.h
@@ -2,9 +2,10 @@
#define SEEN_INKSCAPE_CTRLRECT_H
/**
- * \file sodipodi-ctrlrect.h
+ * @file
* Simple non-transformed rectangle, usable for rubberband.
- *
+ */
+/*
* Authors:
* Lauris Kaplinski <lauris@ximian.com>
* Carl Hetherington <inkscape@carlh.net>
diff --git a/src/display/sp-canvas-group.h b/src/display/sp-canvas-group.h
index 354d389b7..9aa99d563 100644
--- a/src/display/sp-canvas-group.h
+++ b/src/display/sp-canvas-group.h
@@ -1,9 +1,11 @@
#ifndef SEEN_SP_CANVAS_GROUP_H
#define SEEN_SP_CANVAS_GROUP_H
-/** \file
- * SPCanvasGroup
- *
+/**
+ * @file
+ * SPCanvasGroup.
+ */
+/*
* Authors:
* Federico Mena <federico@nuclecu.unam.mx>
* Raph Levien <raph@gimp.org>
diff --git a/src/display/sp-canvas-item.h b/src/display/sp-canvas-item.h
index 415c36566..2c1dbdcf0 100644
--- a/src/display/sp-canvas-item.h
+++ b/src/display/sp-canvas-item.h
@@ -1,9 +1,11 @@
#ifndef SEEN_SP_CANVAS_ITEM_H
#define SEEN_SP_CANVAS_ITEM_H
-/** \file
+/**
+ * @file
* SPCanvasItem.
- *
+ */
+/*
* Authors:
* Federico Mena <federico@nuclecu.unam.mx>
* Raph Levien <raph@gimp.org>
diff --git a/src/display/sp-canvas.h b/src/display/sp-canvas.h
index bffa5e4e9..f0deaa594 100644
--- a/src/display/sp-canvas.h
+++ b/src/display/sp-canvas.h
@@ -1,9 +1,11 @@
#ifndef SEEN_SP_CANVAS_H
#define SEEN_SP_CANVAS_H
-/** \file
+/**
+ * @file
* SPCanvas, SPCanvasBuf.
- *
+ */
+/*
* Authors:
* Federico Mena <federico@nuclecu.unam.mx>
* Raph Levien <raph@gimp.org>