From 45a04278f60e423b4525e8d30ef78a2613637980 Mon Sep 17 00:00:00 2001 From: Abdullah Tahiri Date: Thu, 14 Mar 2019 19:27:30 +0100 Subject: [PATCH] Complete parameter comments --- src/Mod/Sketcher/Gui/CommandConstraints.cpp | 8 ++++++++ src/Mod/Sketcher/Gui/CommandConstraints.h | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/src/Mod/Sketcher/Gui/CommandConstraints.cpp b/src/Mod/Sketcher/Gui/CommandConstraints.cpp index d4583d9515..092f79bb4a 100644 --- a/src/Mod/Sketcher/Gui/CommandConstraints.cpp +++ b/src/Mod/Sketcher/Gui/CommandConstraints.cpp @@ -357,6 +357,8 @@ bool SketcherGui::IsPointAlreadyOnCurve(int GeoIdCurve, int GeoIdPoint, Sketcher /// Makes a simple tangency constraint using extra point + tangent via point /// ellipse => an ellipse /// geom2 => any of an ellipse, an arc of ellipse, a circle, or an arc (of circle) +/// geoId1 => geoid of the ellipse +/// geoId2 => geoid of geom2 /// NOTE: A command must be opened before calling this function, which this function /// commits or aborts as appropriate. The reason is for compatibility reasons with /// other code e.g. "Autoconstraints" in DrawSketchHandler.cpp @@ -422,6 +424,8 @@ void SketcherGui::makeTangentToEllipseviaNewPoint(Sketcher::SketchObject* Obj, /// Makes a simple tangency constraint using extra point + tangent via point /// aoe => an arc of ellipse /// geom2 => any of an arc of ellipse, a circle, or an arc (of circle) +/// geoId1 => geoid of the arc of ellipse +/// geoId2 => geoid of geom2 /// NOTE: A command must be opened before calling this function, which this function /// commits or aborts as appropriate. The reason is for compatibility reasons with /// other code e.g. "Autoconstraints" in DrawSketchHandler.cpp @@ -485,6 +489,8 @@ void SketcherGui::makeTangentToArcOfEllipseviaNewPoint(Sketcher::SketchObject* O /// Makes a simple tangency constraint using extra point + tangent via point /// aoh => an arc of hyperbola /// geom2 => any of an arc of hyperbola, an arc of ellipse, a circle, or an arc (of circle) +/// geoId1 => geoid of the arc of hyperbola +/// geoId2 => geoid of geom2 /// NOTE: A command must be opened before calling this function, which this function /// commits or aborts as appropriate. The reason is for compatibility reasons with /// other code e.g. "Autoconstraints" in DrawSketchHandler.cpp @@ -566,6 +572,8 @@ void SketcherGui::makeTangentToArcOfHyperbolaviaNewPoint(Sketcher::SketchObject* /// Makes a simple tangency constraint using extra point + tangent via point /// aop => an arc of parabola /// geom2 => any of an arc of parabola, an arc of hyperbola an arc of ellipse, a circle, or an arc (of circle) +/// geoId1 => geoid of the arc of parabola +/// geoId2 => geoid of geom2 /// NOTE: A command must be opened before calling this function, which this function /// commits or aborts as appropriate. The reason is for compatibility reasons with /// other code e.g. "Autoconstraints" in DrawSketchHandler.cpp diff --git a/src/Mod/Sketcher/Gui/CommandConstraints.h b/src/Mod/Sketcher/Gui/CommandConstraints.h index 7ea6482373..8152b429b6 100644 --- a/src/Mod/Sketcher/Gui/CommandConstraints.h +++ b/src/Mod/Sketcher/Gui/CommandConstraints.h @@ -57,6 +57,8 @@ bool IsPointAlreadyOnCurve(int GeoIdCurve, int GeoIdPoint, Sketcher::PointPos Po /// Makes a tangency constraint using external construction line between /// ellipse => an ellipse /// geom2 => any of an ellipse, an arc of ellipse, a circle, or an arc (of circle) +/// geoId1 => geoid of the ellipse +/// geoId2 => geoid of geom2 /// NOTE: A command must be opened before calling this function, which this function /// commits or aborts as appropriate. The reason is for compatibility reasons with /// other code e.g. "Autoconstraints" in DrawSketchHandler.cpp @@ -69,6 +71,8 @@ void makeTangentToEllipseviaNewPoint(Sketcher::SketchObject* Obj, /// Makes a tangency constraint using external construction line between /// aoe => an arc of ellipse /// geom2 => any of an arc of ellipse, a circle, or an arc (of circle) +/// geoId1 => geoid of the arc of ellipse +/// geoId2 => geoid of geom2 /// NOTE: A command must be opened before calling this function, which this function /// commits or aborts as appropriate. The reason is for compatibility reasons with /// other code e.g. "Autoconstraints" in DrawSketchHandler.cpp @@ -82,6 +86,8 @@ void makeTangentToArcOfEllipseviaNewPoint(Sketcher::SketchObject* Obj, /// Makes a tangency constraint using external construction line between /// aoh => an arc of hyperbola /// geom2 => any of an arc of hyperbola, an arc of ellipse, a circle, or an arc (of circle) +/// geoId1 => geoid of the arc of hyperbola +/// geoId2 => geoid of geom2 /// NOTE: A command must be opened before calling this function, which this function /// commits or aborts as appropriate. The reason is for compatibility reasons with /// other code e.g. "Autoconstraints" in DrawSketchHandler.cpp @@ -95,6 +101,8 @@ void makeTangentToArcOfHyperbolaviaNewPoint(Sketcher::SketchObject* Obj, /// Makes a simple tangency constraint using extra point + tangent via point /// aop => an arc of parabola /// geom2 => any of an arc of parabola, an arc of hyperbola an arc of ellipse, a circle, or an arc (of circle) +/// geoId1 => geoid of the arc of parabola +/// geoId2 => geoid of geom2 /// NOTE: A command must be opened before calling this function, which this function /// commits or aborts as appropriate. The reason is for compatibility reasons with /// other code e.g. "Autoconstraints" in DrawSketchHandler.cpp