kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Doxygen Typos

Browse Source 
+ doxy whitespace formatting
+ added more misc. typos
+ grammar fixes
[skip ci]
This commit is contained in:
Unknown
2017-10-15 09:33:05 -04:00
committed by wmayer
parent fb2b9d6cef
commit 772c5b1970
12 changed files with 49 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/Doc/primary-groups.dox
View File

@@ -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.
*/

10
src/Mod/Assembly/App/opendcm/moduleShape3d/module.hpp
View File

@@ -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<Derived> append(boost::shared_ptr<Geometry3D> g);
boost::shared_ptr<Derived> append(boost::shared_ptr<Derived> 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<typename Sys>
template<typename Derived>
boost::shared_ptr<Derived> ModuleShape3D<Typelist, ID>::type<Sys>::Shape3D_base<Derived>::clone(Sys& newSys) {
//copy the standart stuff
//copy the standard stuff
boost::shared_ptr<Derived> np = boost::shared_ptr<Derived>(new Derived(*static_cast<Derived*>(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<Typelist, ID>::type<Sys>::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<remove>(g);
m_this->erase(g);
};

50
src/Mod/Cam/App/SpringbackCorrection.h
View File

@@ -28,7 +28,7 @@
#include <Mod/Mesh/App/Core/TopoAlgorithm.h>
#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<double> 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<double> error);
@@ -266,76 +266,76 @@ public:
region */
std::vector< std::pair<unsigned long, double> > RegionEvaluate(const MeshCore::MeshKernel &mesh, std::vector<unsigned long> &RegionFacets, std::vector<Base::Vector3f> &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<Base::Vector3f> 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<double> m_CurvPos;
/** @brief vector containing the minimum curvature-radius-values at all
mesh-points*/
mesh-points */
std::vector<double> m_CurvNeg;
/** @brief */
std::vector<double> m_CurvMax;
/** @brief struct-vector over all edges*/
/** @brief struct-vector over all edges */
std::vector<EdgeStruct> 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<unsigned long> 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<unsigned long> > 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<unsigned long> > m_Regions;
/** @brief */
//std::vector<MeshCore::MeshFacet> 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<MeshCore::MeshKernel> 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<Base::Vector3f> 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<double> m_error;
/** @brief vector containing the initial angle-degrees of all triangles*/
/** @brief vector containing the initial angle-degrees of all triangles */
std::vector<double> m_FaceAng;
/** @brief struct-vector over all mesh-points*/
/** @brief struct-vector over all mesh-points */
std::vector<MeshPnt> m_MeshStruct;
/** @brief vector containing the resulting offset-values of all mesh
points */
std::vector<double> m_Offset;
public:
/** @brief map which links mesh-point to mesh-index*/
/** @brief map which links mesh-point to mesh-index */
std::map<Base::Vector3f,MeshPnt,MeshPntLess > MeshMap;
/** @brief map over all edges*/
/** @brief map over all edges */
std::map<TopoDS_Edge, std::vector<double>, Edge_Less> EdgeMap;
/** @brief vector containing the user-specified faces which stands fix
during the springback-correction*/
during the springback-correction */
std::vector<TopoDS_Face> m_FixFaces;
};
#endif
#endif

4
src/Mod/Mesh/App/Core/MeshIO.cpp
View File

@@ -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");
}
}

2
src/Mod/Part/App/TopoShape.cpp
View File

@@ -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
}

4
src/Mod/PartDesign/Gui/TaskDatumParameters.cpp
View File

@@ -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);

6
src/Mod/PartDesign/Gui/TaskPipeParameters.cpp
View File

@@ -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<PartDesign::Pipe*>(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)

4
src/Mod/Path/Gui/Resources/panels/JobEdit.ui
View File

File diff suppressed because one or more lines are too long

6
src/Mod/Ship/Instance.py
View File

@@ -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):

2
src/Mod/Ship/shipCreateShip/Preview.py
View File

@@ -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

6
src/Mod/Sketcher/Gui/ViewProviderSketch.cpp
View File

@@ -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]);

2
src/Mod/Web/Gui/Resources/ui/TaskDlgSketchfab.ui
View File

@@ -116,7 +116,7 @@
<item>
<widget class="QLabel" name="label_8">
<property name="text">
<string>freecad,</string>
<string>FreeCAD,</string>
</property>
</widget>
</item>