diff options
| author | Jon A. Cruz <jon@joncruz.org> | 2011-10-03 03:44:17 +0000 |
|---|---|---|
| committer | Jon A. Cruz <jon@joncruz.org> | 2011-10-03 03:44:17 +0000 |
| commit | 20097d47e6945bceb57d2335d23fe764f493ab59 (patch) | |
| tree | 47a1f62624d42e0302c2c370c1c23b2670e814ed /src/snap-preferences.cpp | |
| parent | Next pass of doxygen @brief cleanup. (diff) | |
| download | inkscape-20097d47e6945bceb57d2335d23fe764f493ab59.tar.gz inkscape-20097d47e6945bceb57d2335d23fe764f493ab59.zip | |
Another minor pass of Doxygen cleanup.
(bzr r10659)
Diffstat (limited to 'src/snap-preferences.cpp')
| -rw-r--r-- | src/snap-preferences.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/snap-preferences.cpp b/src/snap-preferences.cpp index 25e00718c..250f38b90 100644 --- a/src/snap-preferences.cpp +++ b/src/snap-preferences.cpp @@ -1,6 +1,6 @@ /** * \file snap-preferences.cpp - * \brief Storing of snapping preferences + * Storing of snapping preferences. * * Authors: * Diederik van Lierop <mail@diedenrezi.nl> @@ -120,7 +120,7 @@ bool Inkscape::SnapPreferences::getSnapFrom(Inkscape::SnapSourceType t) const return (_snap_from & t); } /** - * \brief Map snap target to array index. + * Map snap target to array index. * * The status of each snap toggle (in the snap toolbar) is stored as a boolean value in an array. This method returns the position * of relevant boolean in that array, for any given type of snap target. For most snap targets, the enumerated value of that targets @@ -131,9 +131,9 @@ bool Inkscape::SnapPreferences::getSnapFrom(Inkscape::SnapSourceType t) const * - For snap sources, just pass the corresponding snap target instead (each snap source should have a twin snap target, but not vice versa) * - All parameters are passed by reference, and will be overwritten * - * \param target Stores the enumerated snap target, which can be modified to correspond to the array index of this snap target - * \param always_on If true, then this snap target is always active and cannot be toggled - * \param group_on If true, then this snap target is in a snap group that has been enabled (e.g. bbox group, nodes/paths group, or "others" group + * @param target Stores the enumerated snap target, which can be modified to correspond to the array index of this snap target + * @param always_on If true, then this snap target is always active and cannot be toggled + * @param group_on If true, then this snap target is in a snap group that has been enabled (e.g. bbox group, nodes/paths group, or "others" group */ void Inkscape::SnapPreferences::_mapTargetToArrayIndex(Inkscape::SnapTargetType &target, bool &always_on, bool &group_on) const { |