diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/display/cairo-utils.cpp | 29 | ||||
| -rw-r--r-- | src/display/canvas-grid.cpp | 2 | ||||
| -rw-r--r-- | src/display/drawing-context.cpp | 13 | ||||
| -rw-r--r-- | src/display/drawing-group.cpp | 8 | ||||
| -rw-r--r-- | src/display/drawing-image.cpp | 2 | ||||
| -rw-r--r-- | src/display/drawing-item.cpp | 34 | ||||
| -rw-r--r-- | src/display/drawing-shape.cpp | 2 | ||||
| -rw-r--r-- | src/display/drawing-surface.cpp | 37 | ||||
| -rw-r--r-- | src/display/drawing-text.cpp | 2 | ||||
| -rw-r--r-- | src/display/drawing.cpp | 2 | ||||
| -rw-r--r-- | src/display/grayscale.cpp | 3 | ||||
| -rw-r--r-- | src/display/nr-style.cpp | 2 |
12 files changed, 85 insertions, 51 deletions
diff --git a/src/display/cairo-utils.cpp b/src/display/cairo-utils.cpp index a12a3d560..2e2eb42dd 100644 --- a/src/display/cairo-utils.cpp +++ b/src/display/cairo-utils.cpp @@ -345,7 +345,8 @@ ink_cairo_surface_create_for_argb32_pixbuf(GdkPixbuf *pb) return pbs; } -/** @brief Cleanup function for GdkPixbuf. +/** + * Cleanup function for GdkPixbuf. * This function should be passed as the GdkPixbufDestroyNotify parameter * to gdk_pixbuf_new_from_data when creating a GdkPixbuf backed by * a Cairo surface. @@ -356,9 +357,11 @@ void ink_cairo_pixbuf_cleanup(guchar * /*pixels*/, void *data) cairo_surface_destroy(surface); } -/** @brief Create an exact copy of a surface. +/** + * Create an exact copy of a surface. * Creates a surface that has the same type, content type, dimensions and contents - * as the specified surface. */ + * as the specified surface. + */ cairo_surface_t * ink_cairo_surface_copy(cairo_surface_t *s) { @@ -383,9 +386,11 @@ ink_cairo_surface_copy(cairo_surface_t *s) return ns; } -/** @brief Create a surface that differs only in pixel content. +/** + * Create a surface that differs only in pixel content. * Creates a surface that has the same type, content type and dimensions - * as the specified surface. Pixel contents are not copied. */ + * as the specified surface. Pixel contents are not copied. + */ cairo_surface_t * ink_cairo_surface_create_identical(cairo_surface_t *s) { @@ -401,9 +406,11 @@ ink_cairo_surface_create_same_size(cairo_surface_t *s, cairo_content_t c) return ns; } -/** @brief Extract the alpha channel into a new surface. +/** + * Extract the alpha channel into a new surface. * Creates a surface with a content type of CAIRO_CONTENT_ALPHA that contains - * the alpha values of pixels from @a s. */ + * the alpha values of pixels from @a s. + */ cairo_surface_t * ink_cairo_extract_alpha(cairo_surface_t *s) { @@ -623,7 +630,7 @@ guint32 pixbuf_from_argb32(guint32 c) } /** - * @brief Convert pixel data from GdkPixbuf format to ARGB. + * Convert pixel data from GdkPixbuf format to ARGB. * This will convert pixel data from GdkPixbuf format to Cairo's native pixel format. * This involves premultiplying alpha and shuffling around the channels. * Pixbuf data must have an alpha channel, otherwise the results are undefined @@ -642,7 +649,7 @@ convert_pixels_pixbuf_to_argb32(guchar *data, int w, int h, int stride) } /** - * @brief Convert pixel data from ARGB to GdkPixbuf format. + * Convert pixel data from ARGB to GdkPixbuf format. * This will convert pixel data from GdkPixbuf format to Cairo's native pixel format. * This involves premultiplying alpha and shuffling around the channels. */ @@ -659,7 +666,7 @@ convert_pixels_argb32_to_pixbuf(guchar *data, int w, int h, int stride) } /** - * @brief Converts GdkPixbuf's data to premultiplied ARGB. + * Converts GdkPixbuf's data to premultiplied ARGB. * This function will convert a GdkPixbuf in place into Cairo's native pixel format. * Note that this is a hack intended to save memory. When the pixbuf is in Cairo's format, * using it with GTK will result in corrupted drawings. @@ -675,7 +682,7 @@ convert_pixbuf_normal_to_argb32(GdkPixbuf *pb) } /** - * @brief Converts GdkPixbuf's data back to its native format. + * Converts GdkPixbuf's data back to its native format. * Once this is done, the pixbuf can be used with GTK again. */ void diff --git a/src/display/canvas-grid.cpp b/src/display/canvas-grid.cpp index a36252a80..dbf78f561 100644 --- a/src/display/canvas-grid.cpp +++ b/src/display/canvas-grid.cpp @@ -1,5 +1,5 @@ /** @file - * @brief Cartesian grid implementation + * Cartesian grid implementation. */ /* Copyright (C) Johan Engelen 2006-2007 <johan@shouraizou.nl> * Copyright (C) Lauris Kaplinski 2000 diff --git a/src/display/drawing-context.cpp b/src/display/drawing-context.cpp index 3c0c2163b..de5beb0f6 100644 --- a/src/display/drawing-context.cpp +++ b/src/display/drawing-context.cpp @@ -1,6 +1,6 @@ /** * @file - * @brief Cairo drawing context with Inkscape extensions + * Cairo drawing context with Inkscape extensions. *//* * Authors: * Krzysztof Kosiński <tweenk.pl@gmail.com> @@ -19,8 +19,10 @@ namespace Inkscape { using Geom::X; using Geom::Y; -/** @class DrawingContext::Save - * @brief RAII idiom for saving the state of DrawingContext. */ +/** + * @class DrawingContext::Save + * RAII idiom for saving the state of DrawingContext. + */ DrawingContext::Save::Save() : _ct(NULL) @@ -46,8 +48,9 @@ void DrawingContext::Save::save(DrawingContext &ct) _ct->save(); } -/** @class DrawingContext - * @brief Minimal wrapper over Cairo. +/** + * @class DrawingContext + * Minimal wrapper over Cairo. * * This is a wrapper over cairo_t, extended with operations that work * with 2Geom geometrical primitives. Some of this is probably duplicated diff --git a/src/display/drawing-group.cpp b/src/display/drawing-group.cpp index 998c4b6e4..6d52b89fc 100644 --- a/src/display/drawing-group.cpp +++ b/src/display/drawing-group.cpp @@ -1,6 +1,6 @@ /** * @file - * @brief Group belonging to an SVG drawing element + * Group belonging to an SVG drawing element. *//* * Authors: * Krzysztof Kosiński <tweenk.pl@gmail.com> @@ -30,7 +30,8 @@ DrawingGroup::~DrawingGroup() sp_style_unref(_style); } -/** @brief Set whether the group returns children from pick calls. +/** + * Set whether the group returns children from pick calls. * Previously this feature was called "transparent groups". */ void @@ -45,7 +46,8 @@ DrawingGroup::setStyle(SPStyle *style) _setStyleCommon(_style, style); } -/** @brief Set additional transform for the group. +/** + * Set additional transform for the group. * This is applied after the normal transform and mainly useful for * markers, clipping paths, etc. */ diff --git a/src/display/drawing-image.cpp b/src/display/drawing-image.cpp index 20a1eb795..0c8ac9681 100644 --- a/src/display/drawing-image.cpp +++ b/src/display/drawing-image.cpp @@ -1,6 +1,6 @@ /** * @file - * @brief Bitmap image belonging to an SVG drawing + * Bitmap image belonging to an SVG drawing. *//* * Authors: * Krzysztof Kosiński <tweenk.pl@gmail.com> diff --git a/src/display/drawing-item.cpp b/src/display/drawing-item.cpp index 3fe56b6de..bb99ed61d 100644 --- a/src/display/drawing-item.cpp +++ b/src/display/drawing-item.cpp @@ -1,6 +1,6 @@ /** * @file - * @brief Canvas item belonging to an SVG drawing element + * Canvas item belonging to an SVG drawing element. *//* * Authors: * Krzysztof Kosiński <tweenk.pl@gmail.com> @@ -23,8 +23,9 @@ namespace Inkscape { -/** @class DrawingItem - * @brief SVG drawing item for display. +/** + * @class DrawingItem + * SVG drawing item for display. * * This was previously known as NRArenaItem. It represents the renderable * portion of the SVG document. Typically this is created by the SP tree, @@ -210,7 +211,8 @@ DrawingItem::setSensitive(bool s) _sensitive = s; } -/** @brief Enable / disable storing the rendering in memory. +/** + * Enable / disable storing the rendering in memory. * Calling setCached(false, true) will also remove the persistent status */ void @@ -283,7 +285,8 @@ DrawingItem::setItemBounds(Geom::OptRect const &bounds) _item_bbox = bounds; } -/** @brief Update derived data before operations. +/** + * Update derived data before operations. * The purpose of this call is to recompute internal data which depends * on the attributes of the object, but is not directly settable by the user. * Precomputing this data speeds up later rendering, because some items @@ -435,7 +438,8 @@ struct MaskLuminanceToAlpha { } }; -/** @brief Rasterize items. +/** + * Rasterize items. * This method submits the drawing opeartions required to draw this item * to the supplied DrawingContext, restricting drawing the the specified area. * @@ -644,7 +648,8 @@ DrawingItem::_renderOutline(DrawingContext &ct, Geom::IntRect const &area, unsig _drawing.outlinecolor = saved_rgba; // restore outline color } -/** @brief Rasterize the clipping path. +/** + * Rasterize the clipping path. * This method submits drawing operations required to draw a basic filled shape * of the item to the supplied drawing context. Rendering is limited to the * given area. The rendering of the clipped object is composited into @@ -684,7 +689,8 @@ DrawingItem::clip(Inkscape::DrawingContext &ct, Geom::IntRect const &area) } } -/** @brief Get the item under the specified point. +/** + * Get the item under the specified point. * Searches the tree for the first item in the Z-order which is closer than * @a delta to the given point. The pick should be visual - for example * an object with a thick stroke should pick on the entire area of the stroke. @@ -732,7 +738,8 @@ DrawingItem::pick(Geom::Point const &p, double delta, unsigned flags) return NULL; } -/** Marks the current visual bounding box of the item for redrawing. +/** + * Marks the current visual bounding box of the item for redrawing. * This is called whenever the object changes its visible appearance. * For some cases (such as setting opacity) this is enough, but for others * _markForUpdate() also needs to be called. @@ -779,7 +786,8 @@ DrawingItem::_invalidateFilterBackground(Geom::IntRect const &area) } } -/** @brief Marks the item as needing a recomputation of internal data. +/** + * Marks the item as needing a recomputation of internal data. * * This mechanism avoids traversing the entire rendering tree (which could be vast) * on every trivial state changed in any item. Only items marked as needing @@ -843,10 +851,12 @@ DrawingItem::_setStyleCommon(SPStyle *&_style, SPStyle *style) _markForUpdate(STATE_ALL, false); } -/** @brief Compute the caching score. +/** + * Compute the caching score. * * Higher scores mean the item is more aggresively prioritized for automatic - * caching by Inkscape::Drawing. */ + * caching by Inkscape::Drawing. + */ double DrawingItem::_cacheScore() { diff --git a/src/display/drawing-shape.cpp b/src/display/drawing-shape.cpp index 93a4846e0..4ca306092 100644 --- a/src/display/drawing-shape.cpp +++ b/src/display/drawing-shape.cpp @@ -1,6 +1,6 @@ /** * @file - * @brief Shape (styled path) belonging to an SVG drawing + * Shape (styled path) belonging to an SVG drawing. *//* * Authors: * Krzysztof Kosiński <tweenk.pl@gmail.com> diff --git a/src/display/drawing-surface.cpp b/src/display/drawing-surface.cpp index 5cbfaa3fe..bddccbd96 100644 --- a/src/display/drawing-surface.cpp +++ b/src/display/drawing-surface.cpp @@ -1,6 +1,6 @@ /** * @file - * @brief Cairo surface that remembers its origin + * Cairo surface that remembers its origin. *//* * Authors: * Krzysztof Kosiński <tweenk.pl@gmail.com> @@ -20,8 +20,9 @@ using Geom::X; using Geom::Y; -/** @class DrawingSurface - * @brief Drawing surface that remembers its origin. +/** + * @class DrawingSurface + * Drawing surface that remembers its origin. * * This is a very minimalistic wrapper over cairo_surface_t. The main * extra functionality provided by this class is that it automates @@ -35,9 +36,11 @@ using Geom::Y; * of when a DrawingContext is constructed. */ -/** @brief Creates a surface with the given physical extents. +/** + * Creates a surface with the given physical extents. * When a drawing context is created for this surface, its pixels - * will cover the area under the given rectangle. */ + * will cover the area under the given rectangle. + */ DrawingSurface::DrawingSurface(Geom::IntRect const &area) : _surface(NULL) , _origin(area.min()) @@ -45,12 +48,14 @@ DrawingSurface::DrawingSurface(Geom::IntRect const &area) , _pixels(area.dimensions()) {} -/** @brief Creates a surface with the given logical and physical extents. +/** + * Creates a surface with the given logical and physical extents. * When a drawing context is created for this surface, its pixels * will cover the area under the given rectangle. IT will contain * the number of pixels specified by the second argument. * @param logbox Logical extents of the surface - * @param pixdims Pixel dimensions of the surface. */ + * @param pixdims Pixel dimensions of the surface. + */ DrawingSurface::DrawingSurface(Geom::Rect const &logbox, Geom::IntPoint const &pixdims) : _surface(NULL) , _origin(logbox.min()) @@ -58,9 +63,11 @@ DrawingSurface::DrawingSurface(Geom::Rect const &logbox, Geom::IntPoint const &p , _pixels(pixdims) {} -/** @brief Wrap a cairo_surface_t. +/** + * Wrap a cairo_surface_t. * This constructor will take an extra reference on @a surface, which will - * be released on destruction. */ + * be released on destruction. + */ DrawingSurface::DrawingSurface(cairo_surface_t *surface, Geom::Point const &origin) : _surface(surface) , _origin(origin) @@ -137,8 +144,10 @@ DrawingSurface::dropContents() } } -/** @brief Create a drawing context for this surface. - * It's better to use the surface constructor of DrawingContext. */ +/** + * Create a drawing context for this surface. + * It's better to use the surface constructor of DrawingContext. + */ cairo_t * DrawingSurface::createRawContext() { @@ -253,8 +262,10 @@ DrawingCache::prepare() _pending_transform.setIdentity(); } -/** @brief Paints the clean area from cache and modifies the @a area - * parameter to the bounds of the region that must be repainted. */ +/** + * Paints the clean area from cache and modifies the @a area + * parameter to the bounds of the region that must be repainted. + */ void DrawingCache::paintFromCache(DrawingContext &ct, Geom::OptIntRect &area) { diff --git a/src/display/drawing-text.cpp b/src/display/drawing-text.cpp index 6dde9634e..94a9690fb 100644 --- a/src/display/drawing-text.cpp +++ b/src/display/drawing-text.cpp @@ -1,6 +1,6 @@ /** * @file - * @brief Group belonging to an SVG drawing element + * Group belonging to an SVG drawing element. *//* * Authors: * Krzysztof Kosiński <tweenk.pl@gmail.com> diff --git a/src/display/drawing.cpp b/src/display/drawing.cpp index 06183fed2..77f24caf3 100644 --- a/src/display/drawing.cpp +++ b/src/display/drawing.cpp @@ -1,6 +1,6 @@ /** * @file - * @brief SVG drawing for display + * SVG drawing for display. *//* * Authors: * Krzysztof Kosiński <tweenk.pl@gmail.com> diff --git a/src/display/grayscale.cpp b/src/display/grayscale.cpp index e468044d3..f59cf6d23 100644 --- a/src/display/grayscale.cpp +++ b/src/display/grayscale.cpp @@ -73,7 +73,8 @@ guchar luminance(guchar r, guchar g, guchar b) { return luminance & 0xff; } -/** @brief Use this method if there is no other way to find out if grayscale view or not +/** + * Use this method if there is no other way to find out if grayscale view or not. * * In some cases, the choice between normal or grayscale is so deep in the code hierarchy, * that it is not possible to determine whether grayscale is desired or not, without using diff --git a/src/display/nr-style.cpp b/src/display/nr-style.cpp index 6e8ccb030..86102f9e8 100644 --- a/src/display/nr-style.cpp +++ b/src/display/nr-style.cpp @@ -1,6 +1,6 @@ /** * @file - * @brief Style information for rendering + * Style information for rendering. *//* * Authors: * Krzysztof Kosiński <tweenk.pl@gmail.com> |