From 772c5b197087efe612f63e9ecb72a141899552a6 Mon Sep 17 00:00:00 2001 From: Unknown Date: Sun, 15 Oct 2017 09:33:05 -0400 Subject: [PATCH] Doxygen Typos + doxy whitespace formatting + added more misc. typos + grammar fixes [skip ci] --- src/Doc/primary-groups.dox | 2 +- .../App/opendcm/moduleShape3d/module.hpp | 10 ++-- src/Mod/Cam/App/SpringbackCorrection.h | 50 +++++++++---------- src/Mod/Mesh/App/Core/MeshIO.cpp | 4 +- src/Mod/Part/App/TopoShape.cpp | 2 +- .../PartDesign/Gui/TaskDatumParameters.cpp | 4 +- src/Mod/PartDesign/Gui/TaskPipeParameters.cpp | 6 +-- src/Mod/Path/Gui/Resources/panels/JobEdit.ui | 4 +- src/Mod/Ship/Instance.py | 6 +-- src/Mod/Ship/shipCreateShip/Preview.py | 2 +- src/Mod/Sketcher/Gui/ViewProviderSketch.cpp | 6 +-- .../Web/Gui/Resources/ui/TaskDlgSketchfab.ui | 2 +- 12 files changed, 49 insertions(+), 49 deletions(-) diff --git a/src/Doc/primary-groups.dox b/src/Doc/primary-groups.dox index 4eaa0206f8..6184158c82 100644 --- a/src/Doc/primary-groups.dox +++ b/src/Doc/primary-groups.dox @@ -1,7 +1,7 @@ /** \defgroup CORE Core This is the core functionality of FreeCAD. - It groups the Base classes, and the main components of freecad core, + It groups the Base classes, and the main components of FreeCAD core, spread over their App and Gui sides. Core components are programmed in C++ but provide a broad Python API. */ diff --git a/src/Mod/Assembly/App/opendcm/moduleShape3d/module.hpp b/src/Mod/Assembly/App/opendcm/moduleShape3d/module.hpp index bdd5f32422..465eb1283b 100644 --- a/src/Mod/Assembly/App/opendcm/moduleShape3d/module.hpp +++ b/src/Mod/Assembly/App/opendcm/moduleShape3d/module.hpp @@ -360,7 +360,7 @@ struct ModuleShape3D { //disconnect all remove signals of stored geometry/shapes/constraints void disconnectAll(); - //the stroage is private, all things need to be added by this methods. + //the storage is private, all things need to be added by this methods. //this is used to ensure the proper event connections boost::shared_ptr append(boost::shared_ptr g); boost::shared_ptr append(boost::shared_ptr g); @@ -442,7 +442,7 @@ struct ModuleShape3D { struct inheriter_id : public inheriter_base { //we don't have a createshape3d method with identifier, as identifiers can be used to - //specifie creation geometries or shapes. therefore a call would always be ambigious. + //specifie creation geometries or shapes. Therefore a call would always be ambigious. void removeShape3D(ID id); bool hasShape3D(ID id); @@ -541,7 +541,7 @@ template template boost::shared_ptr ModuleShape3D::type::Shape3D_base::clone(Sys& newSys) { - //copy the standart stuff + //copy the standard stuff boost::shared_ptr np = boost::shared_ptr(new Derived(*static_cast(this))); np->m_system = &newSys; //it's possible that the variant contains pointers, so we need to clone them @@ -799,14 +799,14 @@ void ModuleShape3D::type::inheriter_base::removeShape3D(boost m_this->removeGeometry3D(*it); - /* TODO: find out why it iterates over a empty vector and crashs... + /* TODO: find out why it iterates over a empty vector and crashes... //remove all subshapes typedef typename Shape3D::shape3d_iterator sit; for(sit it=g->beginShape3D(); it!=g->endShape3D(); it++) { m_this->removeShape3D(*it); };*/ - //emit remove shape signal bevore actually deleting it + //emit remove shape signal before actually deleting it g->template emitSignal(g); m_this->erase(g); }; diff --git a/src/Mod/Cam/App/SpringbackCorrection.h b/src/Mod/Cam/App/SpringbackCorrection.h index cdffc090a9..8676097755 100644 --- a/src/Mod/Cam/App/SpringbackCorrection.h +++ b/src/Mod/Cam/App/SpringbackCorrection.h @@ -28,7 +28,7 @@ #include #include "cutting_tools.h" -/*! \brief The main class for the SpringbackCorrection routine +/** @brief The main class for the SpringbackCorrection routine It takes a mesh and a Topo_Shape and computes a deformation of the triangulated Topo_Shape. @@ -163,7 +163,7 @@ public: @param deg_Tol limiting forming-angle @param out - \todo undocumented parameter out + @todo undocumented parameter out */ bool Perform(int deg_Tol, bool out); @@ -177,13 +177,13 @@ public: @param aFace @param mesh input-mesh - \todo undocumented parameter aFace + @todo undocumented parameter aFace */ std::vector MeshCurvature(const TopoDS_Face& aFace, const MeshCore::MeshKernel& mesh); /** @brief computes maximum and minimum curvature-values of the specified input-face \p aFace - @param aFace input-face */ + @param aFace input-face */ bool GetCurvature(TopoDS_Face aFace); //bool MirrorMesh(std::vector error); @@ -266,76 +266,76 @@ public: region */ std::vector< std::pair > RegionEvaluate(const MeshCore::MeshKernel &mesh, std::vector &RegionFacets, std::vector &normals); - /** @brief input-mesh*/ + /** @brief input-mesh */ MeshCore::MeshKernel m_Mesh; /** @brief mesh containing the movable regions for the local translation */ MeshCore::MeshKernel m_Mesh_vis; /** @brief mesh containing the fix regions for the local translation */ MeshCore::MeshKernel m_Mesh_vis2; - /** @brief triangulation of the CAD-shape*/ + /** @brief triangulation of the CAD-shape */ MeshCore::MeshKernel m_CadMesh; - /** @brief vector containing translation-vectors at all mesh-points*/ + /** @brief vector containing translation-vectors at all mesh-points */ std::vector m_dist_vec; private: - /** @brief initial input-shape (CAD-model)*/ + /** @brief initial input-shape (CAD-model) */ TopoDS_Shape m_Shape; /** @brief vector containing the maximum curvature-radius-values at all - mesh-points*/ + mesh-points */ std::vector m_CurvPos; /** @brief vector containing the minimum curvature-radius-values at all - mesh-points*/ + mesh-points */ std::vector m_CurvNeg; /** @brief */ std::vector m_CurvMax; - /** @brief struct-vector over all edges*/ + /** @brief struct-vector over all edges */ std::vector m_EdgeStruct; /** @brief index-vector for the region-growing-algorithm containing the - triangles at the current ring-neighbourhood*/ + triangles at the current ring-neighbourhood */ std::vector m_RingVector; /** @brief index-vector for the region-growing-algorithm containing the - triangles of one computed region*/ + triangles of one computed region */ std::vector< std::vector > m_RegionVector; /** @brief index-vector for the region-growing-algorithm containing the - triangles of all computed region*/ + triangles of all computed region */ std::vector< std::vector > m_Regions; /** @brief */ //std::vector m_RegionBounds; - /** @brief external setting-parameters*/ + /** @brief external setting-parameters */ CuttingToolsSettings m_set; /** @brief index which specifies the current ring-neighbourhood for the - region-growing-algorithm*/ + region-growing-algorithm */ int m_RingCurrent; private: /** @brief vector over all input-meshes for the iteration-process */ std::vector m_MeshVec; - /** @brief copy of the initial input-mesh*/ + /** @brief copy of the initial input-mesh */ MeshCore::MeshKernel MeshRef; /** @brief */ //MeshCore::MeshKernel m_Mesh2Fit; - /** @brief vector over the normal-vectors at all mesh-points*/ + /** @brief vector over the normal-vectors at all mesh-points */ std::vector m_normals; /** @brief vector containing the distance-values at all mesh points - between the initial input-shape (CAD-model) and -mesh*/ + between the initial input-shape (CAD-model) and -mesh */ std::vector m_error; - /** @brief vector containing the initial angle-degrees of all triangles*/ + /** @brief vector containing the initial angle-degrees of all triangles */ std::vector m_FaceAng; - /** @brief struct-vector over all mesh-points*/ + /** @brief struct-vector over all mesh-points */ std::vector m_MeshStruct; /** @brief vector containing the resulting offset-values of all mesh points */ std::vector m_Offset; public: - /** @brief map which links mesh-point to mesh-index*/ + /** @brief map which links mesh-point to mesh-index */ std::map MeshMap; - /** @brief map over all edges*/ + /** @brief map over all edges */ std::map, Edge_Less> EdgeMap; /** @brief vector containing the user-specified faces which stands fix - during the springback-correction*/ + during the springback-correction */ std::vector m_FixFaces; }; -#endif \ No newline at end of file +#endif diff --git a/src/Mod/Mesh/App/Core/MeshIO.cpp b/src/Mod/Mesh/App/Core/MeshIO.cpp index 7f53ef2fb4..562d37ad13 100644 --- a/src/Mod/Mesh/App/Core/MeshIO.cpp +++ b/src/Mod/Mesh/App/Core/MeshIO.cpp @@ -207,7 +207,7 @@ bool MeshInput::LoadFormat(std::istream &str, MeshIO::Format fmt) case MeshIO::NAS: return LoadNastran(str); default: - throw Base::FileException("Not supported file format"); + throw Base::FileException("Unsupported file format"); } } @@ -1774,7 +1774,7 @@ bool MeshOutput::SaveFormat(std::ostream &str, MeshIO::Format fmt) const case MeshIO::PY: return SavePython(str); default: - throw Base::FileException("Not supported file format"); + throw Base::FileException("Unsupported file format"); } } diff --git a/src/Mod/Part/App/TopoShape.cpp b/src/Mod/Part/App/TopoShape.cpp index 30af09dc15..744eca2d02 100644 --- a/src/Mod/Part/App/TopoShape.cpp +++ b/src/Mod/Part/App/TopoShape.cpp @@ -306,7 +306,7 @@ TopoDS_Shape TopoShape::getSubShape(const char* Type) const return anIndices.FindKey(index); } - Standard_Failure::Raise("Not supported sub-shape type"); + Standard_Failure::Raise("Unsupported sub-shape type"); return TopoDS_Shape(); // avoid compiler warning } diff --git a/src/Mod/PartDesign/Gui/TaskDatumParameters.cpp b/src/Mod/PartDesign/Gui/TaskDatumParameters.cpp index 29d4b76553..a132c292e1 100644 --- a/src/Mod/PartDesign/Gui/TaskDatumParameters.cpp +++ b/src/Mod/PartDesign/Gui/TaskDatumParameters.cpp @@ -141,7 +141,7 @@ bool TaskDlgDatumParameters::accept() { ext = true; } if(ext) { - // TODO rewrite this to be shared with CmdPartDesignNewSketch::activated() (2015-10-20, Fat-Zer) + // TODO: rewrite this to be shared with CmdPartDesignNewSketch::activated() (2015-10-20, Fat-Zer) QDialog* dia = new QDialog; Ui_Dialog dlg; dlg.setupUi(dia); @@ -174,7 +174,7 @@ bool TaskDlgDatumParameters::accept() { if(!PartGui::TaskDlgAttacher::accept()) return false; - //we need to add the copied features to the body after the command action, as otherwise freecad crashs unexplainable + //we need to add the copied features to the body after the command action, as otherwise FreeCAD crashes unexplainably for(auto obj : copies) { if(pcActiveBody) pcActiveBody->addObject(obj); diff --git a/src/Mod/PartDesign/Gui/TaskPipeParameters.cpp b/src/Mod/PartDesign/Gui/TaskPipeParameters.cpp index e49e5431e3..0d691df581 100644 --- a/src/Mod/PartDesign/Gui/TaskPipeParameters.cpp +++ b/src/Mod/PartDesign/Gui/TaskPipeParameters.cpp @@ -286,7 +286,7 @@ void TaskPipeParameters::exitSelectionMode() { //************************************************************************** //************************************************************************** -// Tassk Orientation +// Task Orientation //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ TaskPipeOrientation::TaskPipeOrientation(ViewProviderPipe* PipeView, bool /*newObj*/, QWidget* parent) @@ -322,7 +322,7 @@ TaskPipeOrientation::TaskPipeOrientation(ViewProviderPipe* PipeView, bool /*newO PartDesign::Pipe* pipe = static_cast(PipeView->getObject()); Gui::Document* doc = Gui::Application::Instance->activeDocument(); - //make sure th euser sees al important things: the base feature to select edges and the + //make sure the user sees an important things: the base feature to select edges and the //spine/auxiliary spine he already selected if(pipe->AuxillerySpine.getValue()) { auto* svp = doc->getViewProvider(pipe->AuxillerySpine.getValue()); @@ -783,7 +783,7 @@ bool TaskDlgPipeParameters::accept() Gui::Command::doCommand(Gui::Command::Gui,"Gui.activeDocument().resetEdit()"); Gui::Command::commitCommand(); - //we need to add the copied features to the body after the command action, as otherwise freecad crashs unexplainable + //we need to add the copied features to the body after the command action, as otherwise FreeCAD crashes unexplainably for(auto obj : copies) { //Dead code: pcActiveBody was previously used without checking for null, so it won't be null here either. //if(pcActiveBody) diff --git a/src/Mod/Path/Gui/Resources/panels/JobEdit.ui b/src/Mod/Path/Gui/Resources/panels/JobEdit.ui index 64ab814cd1..39d1da0204 100644 --- a/src/Mod/Path/Gui/Resources/panels/JobEdit.ui +++ b/src/Mod/Path/Gui/Resources/panels/JobEdit.ui @@ -259,7 +259,7 @@ - <html><head/><body><p>Enter a path and optionally file name (see below) to be used as the default for the post processor export.</p><p>The following substitutions are performed before the name is resolved at the time of the post processing:</p><p>%D ... directory of the active document<br/>%d ... name of the active document (with extension)<br/>%M ... user macro directory<br/>%j ... name of the active Job object</p><p>The following example store all files with the same name as the document the directory /home/freecad (please remove quotes):</p><p>&quot;/home/cnc/%d.g-code&quot;</p><p>See the file save policy below on how to deal with name conflicts.</p></body></html> + <html><head/><body><p>Enter a path and optional file name (see below) to be used as the default for the post processor export.</p><p>The following substitutions are performed before the name is resolved at the time of the post processing:</p><p>%D ... directory of the active document<br/>%d ... name of the active document (with extension)<br/>%M ... user macro directory<br/>%j ... name of the active Job object</p><p>The following example stores all files with the same name as the document in the directory /home/freecad (please remove quotes):</p><p>&quot;/home/cnc/%d.g-code&quot;</p><p>See the file save policy below on how to deal with name conflicts.</p></body></html> @@ -286,7 +286,7 @@ - <html><head/><body><p>Optional arguments passed to the Post Processor. The arguments are specific for each Post Processor, please see it's documentation for details.</p></body></html> + <html><head/><body><p>Optional arguments passed to the Post Processor. The arguments are specific for each Post Processor, please see its documentation for details.</p></body></html> diff --git a/src/Mod/Ship/Instance.py b/src/Mod/Ship/Instance.py index ab844b7b35..d0d905cb85 100644 --- a/src/Mod/Ship/Instance.py +++ b/src/Mod/Ship/Instance.py @@ -122,7 +122,7 @@ class Ship: pass def cleanWeights(self, fp): - """Reanalyse the weights list looking for duplicated opbjects, or + """Reanalyse the weights list looking for duplicated objects, or removed ones. """ if not len(fp.Weights): @@ -150,7 +150,7 @@ class Ship: fp.Weights = filtered_list def cleanTanks(self, fp): - """Reanalyse the weights list looking for duplicated opbjects, or + """Reanalyse the weights list looking for duplicated objects, or removed ones. """ if not len(fp.Tanks): @@ -178,7 +178,7 @@ class Ship: fp.Tanks = filtered_list def cleanLoadConditions(self, fp): - """Reanalyse the weights list looking for duplicated opbjects, or + """Reanalyse the weights list looking for duplicated objects, or removed ones. """ if not len(fp.LoadConditions): diff --git a/src/Mod/Ship/shipCreateShip/Preview.py b/src/Mod/Ship/shipCreateShip/Preview.py index c20d328b31..c13e903292 100644 --- a/src/Mod/Ship/shipCreateShip/Preview.py +++ b/src/Mod/Ship/shipCreateShip/Preview.py @@ -120,7 +120,7 @@ class Preview(object): self.apLineLabel = DrawText('APText', text, Base.Vector(-0.5 * L, 0, zEnd)) - # Draw the amin frame + # Draw the main frame amLine = Part.makeLine((0, -0.5 * B, zStart), (0, -0.5 * B, zEnd)) Part.show(amLine) objs = FreeCAD.ActiveDocument.Objects diff --git a/src/Mod/Sketcher/Gui/ViewProviderSketch.cpp b/src/Mod/Sketcher/Gui/ViewProviderSketch.cpp index 64cc21abb2..0d8b366c63 100644 --- a/src/Mod/Sketcher/Gui/ViewProviderSketch.cpp +++ b/src/Mod/Sketcher/Gui/ViewProviderSketch.cpp @@ -2458,11 +2458,11 @@ void ViewProviderSketch::doBoxSelection(const SbVec2s &startPos, const SbVec2s & Gui::Selection().addSelection(doc->getName(), sketchObject->getNameInDocument(), ss.str().c_str()); } - // This is a rather approximated approach. No it does not guarantie that the whole curve is boxed, specially + // This is a rather approximated approach. No it does not guarantee that the whole curve is boxed, specially // for periodic curves, but it works reasonably well. Including all poles, which could be done, generally // forces the user to select much more than the curve (all the poles) and it would not select the curve in cases // where it is indeed comprised in the box. - // The implementation of the touch mode is also far from a desireable "touch" as it only recognizes touched points not the curve itself + // The implementation of the touch mode is also far from a desirable "touch" as it only recognizes touched points not the curve itself if (pnt1Inside && pnt2Inside || (touchMode && (pnt1Inside || pnt2Inside))) { std::stringstream ss; ss << "Edge" << GeoId + 1; @@ -2536,7 +2536,7 @@ void ViewProviderSketch::updateColor(void) for (int i=0; i < CurvNum; i++) { int GeoId = edit->CurvIdToGeoId[i]; - // CurvId has several vertex a ssociated to 1 material + // CurvId has several vertices associated to 1 material //edit->CurveSet->numVertices => [i] indicates number of vertex for line i. int indexes = (edit->CurveSet->numVertices[i]); diff --git a/src/Mod/Web/Gui/Resources/ui/TaskDlgSketchfab.ui b/src/Mod/Web/Gui/Resources/ui/TaskDlgSketchfab.ui index 5270476f4f..d62194537a 100644 --- a/src/Mod/Web/Gui/Resources/ui/TaskDlgSketchfab.ui +++ b/src/Mod/Web/Gui/Resources/ui/TaskDlgSketchfab.ui @@ -116,7 +116,7 @@ - freecad, + FreeCAD,