Typo fixes for doxygen and source comments

issue #0002914
This commit is contained in:
Kunda
2017-03-30 17:47:37 -04:00
committed by Yorik van Havre
parent e5f2002c92
commit 5aefa825b1
41 changed files with 67 additions and 67 deletions

View File

@@ -62,7 +62,7 @@ SET(Module_SRCS
)
SOURCE_GROUP("Module" FILES ${Module_SRCS})
#externalisation is not possible for msvc as a stupid bug prevents the function definition resolving
#externalization is not possible for msvc as a stupid bug prevents the function definition resolving
if(MSVC)
set(Solver_SRC )
else(MSVC)

View File

@@ -164,7 +164,7 @@ void Geometry<Kernel, Dim, TagList>::setClusterMode(bool iscluster, bool isFixed
m_isInCluster = iscluster;
m_clusterFixed = isFixed;
if(iscluster) {
//we are in cluster, therfore the parameter map should not point to a solver value but to
//we are in cluster, therefore the parameter map should not point to a solver value but to
//the rotated original value;
new(&m_parameter) typename Kernel::VectorMap(&m_rotated(0), m_parameterCount, DS(1,1));
//the local value is the global one as no transformation was applied yet

View File

@@ -98,7 +98,7 @@ struct SignalOwner {
/**
* @brief Disconnects a slot for a specific signal.
*
* Disconnects a slot so that it dosn't get called at signal emittion. It's important to
* Disconnects a slot so that it doesn't get called at signal emission. It's important to
* disconnect the slot by the same boost:function it was connected with.
*
* @tparam S the signal type of interest
@@ -110,10 +110,10 @@ struct SignalOwner {
/**
* @brief Enable or disable signal emittion
* @brief Enable or disable signal emission
*
* If you want to suppress all signals emitted by a object you can do this by calling this function.
* All calls to emitSignal() will be blocked until signals aer reenabled by using this function with
* If you want to suppress all signals emitted by an object you can do this by calling this function.
* All calls to emitSignal() will be blocked until signals are reenabled by using this function with
* onoff = true. Note that signals are not queued, if emitting is disabled all signals are lost.
*
* @param onoff bool value if signals shall be emitted or if they are disabled
@@ -145,14 +145,14 @@ protected:
/**
* @brief Base class for all object types
*
* This class add's property and signal capabilitys to all deriving classes. For properties it is tigthly
* This class adds property and signal capabilities to all deriving classes. For properties it is tightly
* integrated with the system class: It searches systems property map for the derived class as specified by
* the second template parameter and makes it accessible via appopriate functions. Signals are speciefied by a
* the second template parameter and makes it accessible via appropriate functions. Signals are specified by a
* mpl::map with signal name type as key and a boost::function as values.
*
* \tparam Sys class of type System of which the properties are taken
* \tparam Obj the type of the derived object
* \tparam Sig a mpl::map specifing the object's signals by (type - boost::function) pairs
* \tparam Sig an mpl::map specifying the object's signals by (type - boost::function) pairs
**/
template<typename Sys, typename Derived, typename Sig>
struct Object : public PropertyOwner<typename details::properties_by_object<typename Sys::properties, Derived>::type>,
@@ -165,7 +165,7 @@ struct Object : public PropertyOwner<typename details::properties_by_object<type
/**
* @brief Create a new object of the same type with the same values
*
* Returns a new shared_ptr for the Drived type with the same properties as the initial one. If
* Returns a new shared_ptr for the Derived type with the same properties as the initial one. If
* the new pointer should be used in a new system the parameter \param newSys needs to be that
* new system. Overload this function if you have datamembers in any derived class which are not
* copyconstructable.

View File

@@ -458,11 +458,11 @@ PropertyOwner<PropertyList>::PropertyOwner() {
};
/**
* @brief Convienience spezialisation to ease interaction with system class
* @brief Convienience specialization to ease interaction with system class
*
* Normaly property lists are retrieved from the system class, however, there are no empty lists. If no
* Normally property lists are retrieved from the system class, however, there are no empty lists. If no
* property is supplied for a PropertyOwner derived class, a mpl::void_ type will be retrieved. To
* remove the burdon of checking for that type in the class definition this spezialisation is supplied.
* remove the burden of checking for that type in the class definition this specialization is supplied.
**/
template<>
struct PropertyOwner<mpl::void_> {

View File

@@ -24,7 +24,7 @@
#include "opendcm/core/imp/constraint_holder_imp.hpp"
#ifdef DCM_EXTERNAL_CORE
//following macros are used for externalisation. As the holder type can hould a very big set of combinations,
//following macros are used for externalization. As the holder type can hould a very big set of combinations,
//especially with module states recursive incarnation, we explicitly initiate all possible versions of this
//struct so that it must only be compiled once. To get all possible equation
//combinations boost pp is needed.

View File

@@ -29,7 +29,7 @@
#endif
// #ifdef DCM_EXTERNAL_CORE
// //following macros are used for externalisation. As constraint->initalize is very compiler intensive,
// //following macros are used for externalization. As constraint->initialize is very compiler intensive,
// //especially with module states recursive incarnation, we explicitly initiate all possible calls to this
// //function so that it must only be compiled once, one function at a time. To get all possible equation
// //combinations boost pp is needed.

View File

@@ -289,7 +289,7 @@ struct inject_set {
g->set(gt);
};
};
//spezialisation if no type in the typelist has the right weight
//specialization if no type in the typelist has the right weight
template<>
struct inject_set<mpl::void_> {

View File

@@ -20,8 +20,8 @@
#ifndef GCM_FIXED_SHAPE3D_H
#define GCM_FIXED_SHAPE3D_H
//we need constraints to identifie connections between geometries in our shapes, however, if the
//geometries are linked to each other a calculation is not necessary. Therfore a no-equation constraint
//we need constraints to identify connections between geometries in our shapes, however, if the
//geometries are linked to each other a calculation is not necessary. Therefore a no-equation constraint
//is needed
#include <opendcm/core/equations.hpp>

View File

@@ -18,7 +18,7 @@
*/
//move the traits specializations outside of the traits definition to avoid the spirit header parsing every
//time this module is included and just parse it in externalisation mode when the generator is build
//time this module is included and just parse it in externalization mode when the generator is built
#ifndef DCM_PARSER_TRAITS_IMPL_H
#define DCM_PARSER_TRAITS_IMPL_H

View File

@@ -230,7 +230,7 @@ void ViewProviderConstraint::updateData(const App::Property* prop) {
void ViewProviderConstraint::onChanged(const App::Property* prop)
{
// parent expects the app object to be part::feature, but it isn't. so we have to avoid
// the visability prop as this results in accessing of the part::feature and would crash
// the visibility prop as this results in accessing of the part::feature and would crash
if(prop == &Visibility) {
if(Visibility.getValue() && m_selected) {
internal_vp.show();

View File

@@ -539,7 +539,7 @@ App::DocumentObject* FemVTKTools::readResult(const char* filename, App::Document
}
App::DocumentObject* mesh = pcDoc->addObject("Fem::FemMeshObject", "ResultMesh");
FemMesh* fmesh = new FemMesh(); // PropertyFemMesh instance is responsible to relase FemMesh ??
FemMesh* fmesh = new FemMesh(); // PropertyFemMesh instance is responsible to release FemMesh ??
importVTKMesh(dataset, fmesh, scale);
static_cast<PropertyFemMesh*>(mesh->getPropertyByName("FemMesh"))->setValue(*fmesh);
static_cast<App::PropertyLink*>(result->getPropertyByName("Mesh"))->setValue(mesh);

View File

@@ -392,13 +392,13 @@ def edgestofaces(edges,algo=3,eps=0.001):
comp=Part.Compound(edges2)
w = comp.connectEdgesToWires(False,eps).Wires[0]
facel.append(Part.Face(w))
#if w.isValid: #debuging
#if w.isValid: #debugging
# facel.append(Part.Face(w))
#else:
# Part.show(w)
if algo is None:
return facel
elif algo == 1: #stabale behavior
elif algo == 1: #stable behavior
return subtractfaces(facel)
elif algo == 0: #return all faces
return Part.Compound(facel)

View File

@@ -40,7 +40,7 @@ class PartTestCases(unittest.TestCase):
def tearDown(self):
#closing doc
FreeCAD.closeDocument("PartTest")
#print ("omit clos document for debuging")
#print ("omit closing document for debugging")
class PartTestBSplineCurve(unittest.TestCase):
def setUp(self):

View File

@@ -42,7 +42,7 @@ class PartDesignPadTestCases(unittest.TestCase):
def tearDown(self):
#closing doc
FreeCAD.closeDocument("PartDesignTest")
# print ("omit clos document for debuging")
# print ("omit closing document for debugging")
class PartDesignRevolveTestCases(unittest.TestCase):
def setUp(self):

View File

@@ -1422,7 +1422,7 @@ struct ShapeInfo{
// Now find the ture nearest point among the wires returned. Currently
// only closed wire has a ture nearest point, using OCC's
// BRepExtrema_DistShapeShape. We don't do this on open wires, becuase
// BRepExtrema_DistShapeShape. We don't do this on open wires, because
// we haven't implemented wire breaking on open wire yet, and I doubt
// its usefulness.

View File

@@ -397,7 +397,7 @@ class TaskPanel:
axesList = [plt.axes]
if form.all.isChecked():
axesList = plt.axesList
# Set new alignement
# Set new alignment
for axes in axesList:
if form.xAlign.currentIndex() == 0:
axes.xaxis.tick_bottom()

View File

@@ -168,7 +168,7 @@ def DrawText(name,
string -- Text to draw (it is strongly recommended to use format u'').
position -- Point to draw the text.
angle -- Counter clockwise rotation of text.
justification -- Alignement of the text ("Left", "Right" or "Center").
justification -- Alignment of the text ("Left", "Right" or "Center").
colour -- Colour of the text.
size -- Font size (in points pt).

View File

@@ -27,7 +27,7 @@
#include "Util.h"
#include <boost/graph/graph_concepts.hpp>
//#define _GCS_EXTRACT_SOLVER_SUBSYSTEM_ // This enables debuging code intended to extract information to file bug reports against Eigen, not for production code
//#define _GCS_EXTRACT_SOLVER_SUBSYSTEM_ // This enables debugging code intended to extract information to file bug reports against Eigen, not for production code
#ifdef _GCS_EXTRACT_SOLVER_SUBSYSTEM_
#define _PROTECTED_UNLESS_EXTRACT_MODE_ public

View File

@@ -289,7 +289,7 @@ void SoDatumLabel::generatePrimitives(SoAction * action)
// Only the angle intersection point is needed
SbVec3f p0 = pnts[0];
// Load the Paramaters
// Load the Parameters
float length = this->param1.getValue();
float startangle = this->param2.getValue();
float range = this->param3.getValue();
@@ -716,7 +716,7 @@ void SoDatumLabel::GLRender(SoGLRenderAction * action)
// Only the angle intersection point is needed
SbVec3f p0 = pnts[0];
// Load the Paramaters
// Load the Parameters
float length = this->param1.getValue();
float startangle = this->param2.getValue();
float range = this->param3.getValue();

View File

@@ -129,4 +129,4 @@ class SketcherSolverTestCases(unittest.TestCase):
def tearDown(self):
#closing doc
FreeCAD.closeDocument("SketchSolverTest")
#print ("omit close document for debuging")
#print ("omit closing document for debugging")

View File

@@ -60,4 +60,4 @@ class TechDrawTestCases(unittest.TestCase):
def tearDown(self):
#closing doc
FreeCAD.closeDocument("TechDrawTest")
#print ("omit clos document for debuging")
#print ("omit closing document for debugging")

View File

@@ -26,7 +26,7 @@ for i in segments:
for i in wires:
i.reverse()
# make sure that the exterior wires comes as first in the lsit
# make sure that the exterior wires comes as first in the list
wires.insert(0, ext)
faces.append(Part.Face(wires))