summaryrefslogtreecommitdiffstats
path: root/src/object-snapper.cpp
diff options
context:
space:
mode:
authorJon A. Cruz <jon@joncruz.org>2011-10-27 04:55:51 +0000
committerJon A. Cruz <jon@joncruz.org>2011-10-27 04:55:51 +0000
commit2633767789e4264b13ef91a684accf734fb4e94f (patch)
tree0f6bc8d758b8e4bcf01d2dd393166907906c156e /src/object-snapper.cpp
parentCleanup pass on documentation that was dumping garbage into doxygen output. (diff)
downloadinkscape-2633767789e4264b13ef91a684accf734fb4e94f.tar.gz
inkscape-2633767789e4264b13ef91a684accf734fb4e94f.zip
Fixing more broken and split doc comments.
(bzr r10697)
Diffstat (limited to 'src/object-snapper.cpp')
-rw-r--r--src/object-snapper.cpp22
1 files changed, 2 insertions, 20 deletions
diff --git a/src/object-snapper.cpp b/src/object-snapper.cpp
index bf8cf166a..e7d9b774d 100644
--- a/src/object-snapper.cpp
+++ b/src/object-snapper.cpp
@@ -1,5 +1,4 @@
-/**
- * \file object-snapper.cpp
+/*
* Snapping things to objects.
*
* Authors:
@@ -58,9 +57,6 @@ Inkscape::ObjectSnapper::~ObjectSnapper()
delete _paths_to_snap_to;
}
-/**
- * \return Snap tolerance (desktop coordinates); depends on current zoom so that it's always the same in screen pixels
- */
Geom::Coord Inkscape::ObjectSnapper::getSnapperTolerance() const
{
SPDesktop const *dt = _snapmanager->getDesktop();
@@ -73,14 +69,6 @@ bool Inkscape::ObjectSnapper::getSnapperAlwaysSnap() const
return _snapmanager->snapprefs.getObjectTolerance() == 10000; //TODO: Replace this threshold of 10000 by a constant; see also tolerance-slider.cpp
}
-/**
- * Find all items within snapping range.
- * \param parent Pointer to the document's root, or to a clipped path or mask object
- * \param it List of items to ignore
- * \param bbox_to_snap Bounding box hulling the whole bunch of points, all from the same selection and having the same transformation
- * \param clip_or_mask The parent object being passed is either a clip or mask
- */
-
void Inkscape::ObjectSnapper::_findCandidates(SPObject* parent,
std::vector<SPItem const *> const *it,
bool const &first_point,
@@ -354,10 +342,7 @@ void Inkscape::ObjectSnapper::_snapTranslatingGuide(IntermSnapResults &isr,
}
-/**
- * Returns index of first NR_END bpath in array.
- */
-
+/// @todo investigate why Geom::Point p is passed in but ignored.
void Inkscape::ObjectSnapper::_collectPaths(Geom::Point /*p*/,
SnapSourceType const source_type,
bool const &first_point) const
@@ -767,9 +752,6 @@ void Inkscape::ObjectSnapper::constrainedSnap( IntermSnapResults &isr,
}
}
-/**
- * \return true if this Snapper will snap at least one kind of point.
- */
bool Inkscape::ObjectSnapper::ThisSnapperMightSnap() const
{
return true;