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

Typo fixes for doxygen and source comments

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

2
src/App/Application.cpp
View File

@@ -2281,7 +2281,7 @@ std::string Application::FindHomePath(const char* sCall)
std::string Application::FindHomePath(const char* call)
{
// If Python is intialized at this point, then we're being run from
// If Python is initialized at this point, then we're being run from
// MainPy.cpp, which hopefully rewrote argv[0] to point at the
// FreeCAD shared library.
if (!Py_IsInitialized()) {

2
src/App/DocumentObject.h
View File

@@ -224,7 +224,7 @@ protected:
/// recompute only this object
virtual App::DocumentObjectExecReturn *recompute(void);
/** get called by the document to recompute this feature
* Normaly this method get called in the processing of
* Normally this method get called in the processing of
* Document::recompute().
* In execute() the outpupt properties get recomputed
* with the data from linked objects and objects own

2
src/FCConfig.h
View File

@@ -334,7 +334,7 @@ typedef unsigned __int64 uint64_t;
//# pragma warning( disable : 4503 )
//# pragma warning( disable : 4786 ) // specifier longer then 255 chars
//# pragma warning( disable : 4290 ) // not implemented throw specification
# pragma warning( disable : 4996 ) // suppress depricated warning for e.g. open()
# pragma warning( disable : 4996 ) // suppress deprecated warning for e.g. open()
#if defined(WIN64) || defined(_WIN64) || defined(__WIN64__)
# pragma warning( disable : 4244 )
# pragma warning( disable : 4267 )

2
src/Gui/DlgParameterImp.h
View File

@@ -167,7 +167,7 @@ protected Q_SLOTS:
void onCreateBoolItem();
/** Defines that the first column is editable.
* @note We need to reimplement this method as QTreeWidgetItem::flags()
* doesn't have an int paramater.
* doesn't have an int parameter.
*/
bool edit ( const QModelIndex & index, EditTrigger trigger, QEvent * event );

2
src/Gui/Macro.h
View File

@@ -82,7 +82,7 @@ public:
/// insert a new line in the macro
void addLine(LineType Type,const char* sLine);
/** Set the active module
* This is normaly done by the workbench switch. It sets
* This is normally done by the workbench switch. It sets
* the actually active application module so when the macro
* gets started the right import can be issued.
*/

2
src/Gui/MayaGestureNavigationStyle.cpp
View File

@@ -445,7 +445,7 @@ SbBool MayaGestureNavigationStyle::processSoEvent(const SoEvent * const ev)
this->mousedownConsumedCount = 0;
// start DRAGGING mode (orbit)
// if not pressing left mouse button then it asumes is right mouse button and starts ZOOMING mode
// if not pressing left mouse button then it assumes is right mouse button and starts ZOOMING mode
setViewingMode(this->button1down ? NavigationStyle::DRAGGING : NavigationStyle::ZOOMING);
processed = true;
} else {

2
src/Gui/ProgressBar.cpp
View File

@@ -428,7 +428,7 @@ void ProgressBar::leaveControlEvents()
{
qApp->removeEventFilter(this);
// relase the keyboard again
// release the keyboard again
releaseKeyboard();
}

2
src/Gui/ProgressDialog.cpp
View File

@@ -307,7 +307,7 @@ void ProgressDialog::leaveControlEvents()
{
qApp->removeEventFilter(this);
// relase the keyboard again
// release the keyboard again
releaseKeyboard();
}

2
src/Gui/WinNativeGestureRecognizers.cpp
View File

@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
#if !defined(QT_NO_NATIVE_GESTURES)
//#include <private/qevent_p.h>
//this include is not avalable on conda Qt, see https://forum.freecadweb.org/viewtopic.php?f=4&t=21405&p=167395#p167395
//this include is not available on conda Qt, see https://forum.freecadweb.org/viewtopic.php?f=4&t=21405&p=167395#p167395
//copy-pasted from this header:
class QNativeGestureEvent : public QEvent
{

2
src/Mod/Assembly/App/CMakeLists.txt
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)

2
src/Mod/Assembly/App/opendcm/core/imp/geometry_imp.hpp
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

16
src/Mod/Assembly/App/opendcm/core/object.hpp
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.

6
src/Mod/Assembly/App/opendcm/core/property.hpp
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_> {

2
src/Mod/Assembly/App/opendcm/module3d/imp/constraint3d_holder_imp.hpp
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.

2
src/Mod/Assembly/App/opendcm/module3d/imp/constraint3d_imp.hpp
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.

2
src/Mod/Assembly/App/opendcm/module3d/imp/state_imp.hpp
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_> {

4
src/Mod/Assembly/App/opendcm/moduleShape3d/fixed.hpp
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>

2
src/Mod/Assembly/App/opendcm/moduleState/imp/traits_impl.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

2
src/Mod/Assembly/Gui/ViewProviderConstraint.cpp
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();

2
src/Mod/Fem/App/FemVTKTools.cpp
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);

4
src/Mod/OpenSCAD/OpenSCAD2Dgeom.py
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)

2
src/Mod/Part/TestPartApp.py
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):

2
src/Mod/PartDesign/TestPartDesignApp.py
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):

2
src/Mod/Path/App/Area.cpp
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.

2
src/Mod/Plot/plotAxes/TaskPanel.py
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()

2
src/Mod/Ship/shipCreateShip/Preview.py
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).

2
src/Mod/Sketcher/App/planegcs/Constraints.h
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

4
src/Mod/Sketcher/Gui/SoDatumLabel.cpp
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();

2
src/Mod/Sketcher/TestSketcherApp.py
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")

2
src/Mod/TechDraw/TestTechDrawApp.py
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")

2
src/Mod/TemplatePyMod/Mesh2Shape.py
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))

2
src/Tools/MakeMacBundleRelocatable.py
View File

@@ -64,7 +64,7 @@ class DepsGraph:
def visit(self, operation, op_args=[]):
""""
Preform a depth first visit of the graph, calling operation
Perform a depth first visit of the graph, calling operation
on each node.
"""
stack = []

20
src/Tools/SubWCRev.py
View File

@@ -170,12 +170,12 @@ class GitControl(VersionControl):
def revisionNumber(self, srcdir,origin=None):
"""sets the revision number
for master and release branches all commits are counted
for other branches the version numver is split in two parts
the first number reflects the number of commits in common with the
blessed master repository.
the second part, seperated by " +"reflects the number of commits that are
different form the master repository"""
for master and release branches all commits are counted
for other branches the version numver is split in two parts
the first number reflects the number of commits in common with the
blessed master repository.
the second part, separated by " +" reflects the number of commits that are
different from the master repository"""
#referencecommit="f119e740c87918b103140b66b2316ae96f136b0e"
#referencerevision=4138
referencecommit="6b3d7b17a749e03bcbf2cf79bbbb903137298c44"
@@ -208,10 +208,10 @@ different form the master repository"""
def namebranchbyparents(self):
"""name multiple branches in case that the last commit was a merge
a merge is identified by having two or more parents
if the describe does not return a ref name (the hash is added)
if one parent is the master and the second one has no ref name, one branch was
merged."""
a merge is identified by having two or more parents
if the describe does not return a ref name (the hash is added)
if one parent is the master and the second one has no ref name, one branch was
merged."""
parents=os.popen("git log -n1 --pretty=%P").read()\
.strip().split(' ')
if len(parents) >= 2: #merge commit

2
src/Tools/fcbt/BuildDoc.py
View File

@@ -14,7 +14,7 @@ ps = os.pathsep
ds = os.sep
#====================================================================
# script asume to run in src/Doc
# script assumes to run in src/Doc
#os.chdir("e:/Develop/FreeCADWin/src/Doc")
LogFile = open("MakeDoc.log",'w')
if not os.path.isdir("../../doc"):

2
src/Tools/fcbt/DistBin.py
View File

@@ -19,7 +19,7 @@ DistBin = DistName + "_binary_WinX86"
DistDir = "../../DistTemp/"
#====================================================================
# script asume to run in src/Tools
# script assumes to run in src/Tools
DistTools.EnsureDir(DistDir)
if (DistTools.EnsureDir(DistDir+DistBin) == 1):

4
src/Tools/fcbt/DistSrc.py
View File

@@ -19,7 +19,7 @@ DistSrc = DistName + "_src"
DistDir = "../../DistTemp/"
#====================================================================
# script asume to run in src/Tools
# script assumes to run in src/Tools
DistTools.EnsureDir(DistDir)
if (DistTools.EnsureDir(DistDir+DistSrc) == 1):
@@ -41,7 +41,7 @@ FileTools.cpallWithFilter('../../src',DistDir+DistSrc+'/src',FileTools.SetUpFilt
#DistTools.cpfile("../Tools/BuildTool.py",DistDir+DistBin+"/BuildTool.py")
#====================================================================
# ziping a archiv
# zipping an archive
os.popen("7z a -tzip "+ DistDir+DistSrc+".zip "+ DistDir+DistSrc + " -mx9")
FileTools.rmall(DistDir+DistSrc)

2
src/Tools/generate.py
View File

@@ -13,7 +13,7 @@ Options:
Generate source code out of an model definition.
Autor:
Author:
(c) 2006 Juergen Riegel
juergen.riegel@web.de
Licence: GPL

10
src/Tools/generateTemplates/templateClassPyExport.py
View File

@@ -28,7 +28,7 @@ class TemplateClassPyExport (template.ModelTemplate):
TemplateHeader = """
// This file is generated by src/Tools/generateTemaplates/templateClassPyExport.py out of the XML file
// Every change you make here get lost at the next full rebuild!
// Every change you make here gets lost in the next full rebuild!
#ifndef @self.export.Namespace.upper()@_@self.export.Name.upper()@_H
#define @self.export.Namespace.upper()@_@self.export.Name.upper()@_H
@@ -229,8 +229,8 @@ public:
TemplateModule = """
// This file is generated by src/Tools/generateTemaplates/templateClassPyExport.py out of the .XML file
// Every change you make here get lost at the next full rebuild!
// This File is normaly build as an include in @self.export.Name@Imp.cpp! Its not intended to be in a project!
// Every change you make here gets lost in the next full rebuild!
// This File is normally built as an include in @self.export.Name@Imp.cpp! It's not intended to be in a project!
#include <boost/filesystem/path.hpp>
#include <boost/filesystem/operations.hpp>
@@ -466,7 +466,7 @@ PyObject * @self.export.Name@::staticCallback_@i.Name@ (PyObject *self, PyObject
return NULL;
}
// test if twin object not allready deleted
// test if twin object isn't already deleted
if (!static_cast<PyObjectBase*>(self)->isValid()) {
PyErr_SetString(PyExc_ReferenceError, "This object is already deleted most likely through closing a document. This reference is no longer valid!");
return NULL;
@@ -1119,7 +1119,7 @@ int @self.export.Name@::setCustomAttributes(const char* /*attr*/, PyObject* /*ob
"""
# here the template for the user part of the implementation. This gets NOT overridden when already existing
# Here's the template for the user part of the implementation. This does NOT get overridden if it already exists.
TemplateImplement = """
#include "PreCompiled.h"

2
src/Tools/generateTemplates/templateModuleAppFeature.py
View File

@@ -70,7 +70,7 @@ PROPERTY_SOURCE(@self.module.Name@::@self.feature.Name@, App::Feature)
-
}
"""
# here the template for the user part of the implementation. This gets NOT overrite when allready exist
# Here's the template for the user part of the implementation. This does NOT get overwritten if it already exists.
TemplateImplement = """
//
#include "PreCompiled.h"

2
src/Tools/thumbs/ThumbnailProvider/FCConfig.h
View File

@@ -163,7 +163,7 @@ typedef unsigned __int64 uint64_t;
// here get the warnings of too long specifiers disabled (needed for VC6)
#ifdef _MSC_VER
# pragma warning( disable : 4251 )
# pragma warning( disable : 4996 ) // suppress depricated warning for e.g. open()
# pragma warning( disable : 4996 ) // suppress deprecated warning for e.g. open()
#if defined(WIN64) || defined(_WIN64) || defined(__WIN64__)
# pragma warning( disable : 4244 )
# pragma warning( disable : 4267 )

2
src/Tools/updatets.py
View File

@@ -30,7 +30,7 @@ Usage = """updatets - update all .ts files found in the source directories
Usage:
updatets
Autor:
Author:
(c) 2010 Werner Mayer
Licence: GPL