Skip to content

Commit

Permalink
Fix source comment / documentation typos
Browse files Browse the repository at this point in the history
  • Loading branch information
luz paz authored and sethhillbrand committed Jun 9, 2021
1 parent 053bd66 commit f968fc8
Show file tree
Hide file tree
Showing 261 changed files with 422 additions and 422 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ common/pcb_keywords.cpp
include/pcb_lexer.h
fp-info-cache

# demo project auxillary files
# demo project auxiliary files
demos/**/*-bak
demos/**/_autosave-*
demos/**/fp-info-cache
Expand Down
2 changes: 1 addition & 1 deletion 3d-viewer/3d_math.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
*
* @param aInclination θ ∈ [0, π]
* @param aAzimuth φ ∈ [0, 2π]
* @return Cartesian cordinates
* @return Cartesian coordinates
*/
inline SFVEC3F SphericalToCartesian( float aInclination, float aAzimuth )
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

/**
* @file bvh_packet_traversal.cpp
* @brief This file implementes packet traversal over the BVH PBRT implementation.
* @brief This file implements packet traversal over the BVH PBRT implementation.
*/

#include "bvh_pbrt.h"
Expand Down
2 changes: 1 addition & 1 deletion 3d-viewer/3d_rendering/3d_render_raytracing/frustum.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

#include "frustum.h"

// !TODO: optimize wih SSE
// !TODO: optimize with SSE
//#if(GLM_ARCH != GLM_ARCH_PURE)
#if 0
#error not implemented
Expand Down
2 changes: 1 addition & 1 deletion 3d-viewer/3d_rendering/3d_render_raytracing/frustum.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
#include "shapes3D/bbox_3d.h"
#include "ray.h"

// !TODO: optimize wih SSE
// !TODO: optimize with SSE
//#if(GLM_ARCH != GLM_ARCH_PURE)
#if 0
#error not implemented
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

/**
* @file mortoncodes.cpp
* @brief Implementes Morton Codes base on the implementation of Fabian “ryg” Giesen
* @brief Implements Morton Codes base on the implementation of Fabian “ryg” Giesen
* https://fgiesen.wordpress.com/2009/12/13/decoding-morton-codes/
*/

Expand Down
2 changes: 1 addition & 1 deletion 3d-viewer/3d_rendering/3d_render_raytracing/mortoncodes.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

/**
* @file mortoncodes.h
* @brief Implementes Morton Codes
* @brief Implements Morton Codes
* https://fgiesen.wordpress.com/2009/12/13/decoding-morton-codes/
* http://www.forceflow.be/2013/10/07/morton-encodingdecoding-through-bit-interleaving-implementations/
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ bool CYLINDER::IntersectP(const RAY& aRay , float aMaxDistance ) const

bool CYLINDER::Intersects( const BBOX_3D& aBBox ) const
{
// !TODO: improove
// !TODO: improve
return m_bbox.Intersects( aBBox );
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ static const unsigned int s_modulo[] = { 0, 1, 2, 0, 1 };

bool TRIANGLE::Intersect( const RAY& aRay, HITINFO& aHitInfo ) const
{
//!TODO: precalc this, improove it
//!TODO: precalc this, improve it
#define ku s_modulo[m_k + 1]
#define kv s_modulo[m_k + 2]

Expand Down Expand Up @@ -298,7 +298,7 @@ bool TRIANGLE::IntersectP( const RAY& aRay, float aMaxDistance ) const

bool TRIANGLE::Intersects( const BBOX_3D& aBBox ) const
{
//!TODO: improove
//!TODO: improve
return m_bbox.Intersects( aBBox );
}

Expand Down
2 changes: 1 addition & 1 deletion 3d-viewer/3d_rendering/legacy/create_scene.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ OPENGL_RENDER_LIST* RENDER_3D_LEGACY::generateHoles( const LIST_OBJECT2D& aListH
}
}

// Note: he can have a aListHolesObject2d whith holes but without countours
// Note: he can have a aListHolesObject2d with holes but without contours
// eg: when there are only NPTH on the list and the contours were not added
if( aPoly.OutlineCount() > 0 )
{
Expand Down
2 changes: 1 addition & 1 deletion 3d-viewer/3d_rendering/legacy/layer_triangles.h
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ class TRIANGLE_LIST
const SFVEC3F& aN4 );

/**
* Get the array of vertexes.
* Get the array of vertices.
*
* @return a pointer to the start of array vertex.
*/
Expand Down
2 changes: 1 addition & 1 deletion 3d-viewer/3d_rendering/test_cases.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ void Run_3d_viewer_test_cases()
bbox3d.Set( SFVEC3F(- 1.0f, -1.0f, 1.0f ), SFVEC3F( 0.0f, 0.0f, 2.0f ) );
wxASSERT( frustum.Intersect( bbox3d ) == true );

// !TODO: The frustum alg is not excluse all the the situations
// !TODO: The frustum alg does not exclude all the situations
//bbox3d.Set( SFVEC3F(-1.0f, -1.0f, z+1.0f), SFVEC3F(+1.0f,+1.0f, +z+2.0f) );
//wxASSERT( frustum.Intersect( bbox3d ) == false );

Expand Down
4 changes: 2 additions & 2 deletions 3d-viewer/3d_rendering/trackball.h
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@
* the mouse, scaled so they are from (-1.0 ... 1.0).
*
* The resulting rotation is returned as a quaternion rotation in the
* first paramater.
* first parameter.
*/
void trackball( double q[4], double p1x, double p1y, double p2x, double p2y );

/*
* Given two quaternions, add them together to get a third quaternion.
* Adding quaternions to get a compound rotation is analagous to adding
* Adding quaternions to get a compound rotation is analogous to adding
* translations to get a compound translation. When incrementally
* adding rotations, the first argument here should be the new
* rotation, the second and third the total rotation (which will be
Expand Down
2 changes: 1 addition & 1 deletion 3d-viewer/3d_viewer/eda_3d_viewer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ EDA_3D_VIEWER::EDA_3D_VIEWER( KIWAY *aKiway, PCB_BASE_FRAME *aParent, const wxSt
m_auimgr.AddPane( m_canvas, EDA_PANE().Canvas().Name( "DrawFrame" ).Center() );

// Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
// hidding it.
// hiding it.
m_auimgr.Update();

// We don't want the infobar displayed right away
Expand Down
2 changes: 1 addition & 1 deletion 3d-viewer/common_ogl/ogl_attr_list.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ const int* OGL_ATT_LIST::GetAttributesList( ANTIALIASING_MODE aAntiAliasingMode
}
}

// Disable antialising if it failed or was not requested
// Disable antialiasing if it failed or was not requested
if( aAntiAliasingMode == ANTIALIASING_MODE::AA_NONE )
{
// Remove multisampling information
Expand Down
2 changes: 1 addition & 1 deletion 3d-viewer/credits.txt
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ Etay Meiri, email: ogldev1 gmail
mortoncodes.cpp
---------------

Implementes Morton Codes base on the implementation of Fabian “ryg” Giesen
Implements Morton Codes base on the implementation of Fabian “ryg” Giesen
https://fgiesen.wordpress.com/2009/12/13/decoding-morton-codes/


Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -426,7 +426,7 @@ if( MSVC )
string( APPEND CMAKE_CXX_FLAGS " /bigobj" )

# Exception handling
# Remove the potential default EHsc option cmake doesnt allow us to remove easily
# Remove the potential default EHsc option cmake doesn't allow us to remove easily
string( REPLACE "/EHsc" "" CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS} )
if( KICAD_WIN32_CONTEXT_WINFIBER )
# /EHsc: ensure standard exception C++ unwinding is enabled, "extern C" can never throw exceptions
Expand Down
2 changes: 1 addition & 1 deletion CMakeModules/BuildSteps/TokenList2DsnLexer.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ set( includeFileHeader
* C++ does not put enum _values_ in separate namespaces unless the enum itself
* is in a separate namespace. All the token enums must be in separate namespaces
* otherwise the C++ compiler will eventually complain if it sees more than one
* DSNLEXER in the same compilation unit, say by mutliple header file inclusion.
* DSNLEXER in the same compilation unit, say by multiple header file inclusion.
* Plus this also enables re-use of the same enum name T. A typedef can always be used
* to clarify which enum T is in play should that ever be a problem. This is
* unlikely since Parse() functions will usually only be exposed to one header
Expand Down
2 changes: 1 addition & 1 deletion CMakeModules/FindwxWidgets.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -977,7 +977,7 @@ if (_wx_lib_missing)
endif()


# Check if a specfic version was requested by find_package().
# Check if a specific version was requested by find_package().
if(wxWidgets_FOUND)
find_file(_filename wx/version.h PATHS ${wxWidgets_INCLUDE_DIRS} NO_DEFAULT_PATH)
DBG_MSG("_filename: ${_filename}")
Expand Down
2 changes: 1 addition & 1 deletion CMakeModules/GetPrerequisites.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ to 1 all prerequisites will be found recursively, if set to 0 only
direct prerequisites are listed. <exclude_system> must be 0 or 1
indicating whether to include or exclude "system" prerequisites. With
<verbose> set to 0 only the full path names of the prerequisites are
printed, set to 1 extra informatin will be displayed.
printed, set to 1 and extra information will be displayed.

::

Expand Down
2 changes: 1 addition & 1 deletion CMakeModules/KiCadVersion.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@
set( KICAD_SEMANTIC_VERSION "5.99.0-unknown" )

# Default the version to the semantic version.
# This is overriden by the git repository tag though (if using git)
# This is overridden by the git repository tag though (if using git)
set( KICAD_VERSION "${KICAD_SEMANTIC_VERSION}" )
2 changes: 1 addition & 1 deletion CMakeModules/UsewxWidgets.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# # Note that for MinGW users the order of libs is important!
# FIND_PACKAGE(wxWidgets REQUIRED net gl core base)
# INCLUDE(${wxWidgets_USE_FILE})
# # and for each of your dependant executable/library targets:
# # and for each of your dependent executable/library targets:
# TARGET_LINK_LIBRARIES(<YourTarget> ${wxWidgets_LIBRARIES})
#
# DEPRECATED
Expand Down
2 changes: 1 addition & 1 deletion CMakeModules/config.h.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

#cmakedefine HAVE_STRNCASECMP

#cmakedefine HAVE_STRTOKR // spelled odly to differ from wx's similar test
#cmakedefine HAVE_STRTOKR // spelled oddly to differ from wx's similar test

// Handle platform differences in math.h
#cmakedefine HAVE_MATH_H
Expand Down
2 changes: 1 addition & 1 deletion bitmap2component/bitmap2component.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ void BITMAPCONV_INFO::createOutputData( BMP2CMP_MOD_LAYER aModLayer )

// The layer name has meaning only for .kicad_mod files.
// For these files the header creates 2 invisible texts: value and ref
// (needed but not usefull) on silk screen layer
// (needed but not useful) on silk screen layer
outputDataHeader( getBoardLayerName( MOD_LYR_FSILKS ) );

bool main_outline = true;
Expand Down
2 changes: 1 addition & 1 deletion bitmaps_png/icons/mk_icn.sh
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ do
echo "file $fl converted."
done

# covert .png files into .ico files using "icotool" from icoutils
# convert .png files into .ico files using "icotool" from icoutils
# (see http://www.nongnu.org/icoutils/)
cd ../icons
for fl in $ICON_FILES
Expand Down
2 changes: 1 addition & 1 deletion common/dialogs/dialog_color_picker.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ void DIALOG_COLOR_PICKER::drawRGBPalette()
// Reserve room to draw cursors inside the bitmap
half_size -= m_cursorsSize/2;

// Draw the 3 RGB cursors, usiing white color to make them always visible:
// Draw the 3 RGB cursors, using white color to make them always visible:
wxPen pen( wxColor( 255, 255, 255 ) );
wxBrush brush( wxColor( 0, 0, 0 ), wxBRUSHSTYLE_TRANSPARENT );
bitmapDC.SetPen( pen );
Expand Down
2 changes: 1 addition & 1 deletion common/dialogs/panel_common_settings_base.h
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ class PANEL_COMMON_SETTINGS_BASE : public RESETTABLE_PANEL
wxStaticText* m_staticText17;
wxCheckBox* m_cbRememberOpenFiles;

// Virtual event handlers, override them in your derived class
// Virtual event handlers, overide them in your derived class
virtual void OnTextEditorClick( wxCommandEvent& event ) { event.Skip(); }
virtual void onUpdateUIPdfPath( wxUpdateUIEvent& event ) { event.Skip(); }
virtual void OnPDFViewerClick( wxCommandEvent& event ) { event.Skip(); }
Expand Down
2 changes: 1 addition & 1 deletion common/dialogs/wx_html_report_box.h
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class WX_HTML_REPORT_BOX : public wxHtmlWindow, public REPORTER

/**
* Build the HTML messages page.
* Call it if the immediate mode is not actived to be able to display them
* Call it if the immediate mode is not activated to be able to display them
*/
void Flush();

Expand Down
2 changes: 1 addition & 1 deletion common/eda_base_frame.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -573,7 +573,7 @@ void EDA_BASE_FRAME::LoadWindowState( const WINDOW_STATE& aState )
// an upper corner is not allowed
#define SCREEN_BORDER_REGION 0.10
#else
// Windows uses a very rectangular clearly defined display region, there is no ambigious "screen border region"
// Windows uses a very rectangular clearly defined display region, there is no ambiguous "screen border region"
// GetClientArea already accounts for the taskbar stealing display space
#define SCREEN_BORDER_REGION 0
#endif
Expand Down
2 changes: 1 addition & 1 deletion common/eda_dde.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ class ASYNC_SOCKET_HOLDER
wxSocketClient* sock_client;
wxIPV4address addr;

// Create a connexion
// Create a connection
addr.Hostname( HOSTNAME );
addr.Service( port );

Expand Down
2 changes: 1 addition & 1 deletion common/eda_rect.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ bool EDA_RECT::Intersects( const wxPoint& aPoint1, const wxPoint& aPoint2 ) cons
point4.x = GetOrigin().x;
point4.y = GetEnd().y;

//Only need to test 3 sides since a straight line cant enter and exit on same side
//Only need to test 3 sides since a straight line can't enter and exit on same side
if( SegmentIntersectsSegment( aPoint1, aPoint2, GetOrigin(), point2 ) )
return true;

Expand Down
2 changes: 1 addition & 1 deletion common/gal/opengl/opengl_gal.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ OPENGL_GAL::OPENGL_GAL( GAL_DISPLAY_OPTIONS& aDisplayOptions, wxWindow* aParent,

SetTarget( TARGET_NONCACHED );

// Avoid unitialized variables:
// Avoid uninitialized variables:
ufm_worldPixelSize = 1;
ufm_screenPixelSize = 1;
ufm_pixelSizeMultiplier = 1;
Expand Down
2 changes: 1 addition & 1 deletion common/gbr_metadata.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,7 @@ bool FormatNetAttribute( std::string& aPrintedText, std::string& aLastNetAttribu
// the entire dictionary is cleared
// If m_TryKeepPreviousAttributes is true, only the no longer existing attribute
// is cleared.
// Note: to avoid interaction beteween clear attributes and set attributes
// Note: to avoid interaction between clear attributes and set attributes
// the clear attribute is inserted first.
bool clearDict = false;

Expand Down
2 changes: 1 addition & 1 deletion common/gr_basic.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ void GRLineArray( EDA_RECT* aClipBox, wxDC* aDC, std::vector<wxPoint>& aLines,
aClipBox->Inflate(-aWidth/2);
}

// Draw the outline of a thick segment wih rounded ends
// Draw the outline of a thick segment with rounded ends
void GRCSegm( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1, int x2, int y2,
int width, int aPenSize, COLOR4D Color )
{
Expand Down
2 changes: 1 addition & 1 deletion common/kiway_express.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
// All things in due course.
const wxEventType KIWAY_EXPRESS::wxEVENT_ID = wxNewEventType();
#else
const wxEventType KIWAY_EXPRESS::wxEVENT_ID = 30000; // commmon accross all link images, hopefully unique.
const wxEventType KIWAY_EXPRESS::wxEVENT_ID = 30000; // common across all link images, hopefully unique.
#endif


Expand Down
2 changes: 1 addition & 1 deletion common/kiway_player.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ bool KIWAY_PLAYER::ShowModal( wxString* aResult, wxWindow* aResultantFocusWindow
SetFocus();

{
// We have to disable all frames but the the modal one.
// We have to disable all frames but the modal one.
// wxWindowDisabler does that, but it also disables all top level windows
// We do not want to disable top level windows which are child of the modal one,
// if they are enabled.
Expand Down
2 changes: 1 addition & 1 deletion common/plotters/HPGL_plotter.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ bool HPGL_PLOTTER::StartPlot()
wxASSERT( m_outputFile );
fprintf( m_outputFile, "IN;VS%d;PU;PA;SP%d;\n", penSpeed, penNumber );

// Set HPGL Pen Thickness (in mm) (usefull in polygon fill command)
// Set HPGL Pen Thickness (in mm) (useful in polygon fill command)
double penThicknessMM = userToDeviceSize( penDiameter )/40;
fprintf( m_outputFile, "PT %.1f;\n", penThicknessMM );

Expand Down
2 changes: 1 addition & 1 deletion common/plotters/PDF_plotter.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -757,7 +757,7 @@ bool PDF_PLOTTER::EndPlot()

if( m_title.IsEmpty() )
{
// Windows uses '\' and other platforms ue '/' as separator
// Windows uses '\' and other platforms use '/' as separator
m_title = m_filename.AfterLast( '\\');
m_title = m_title.AfterLast( '/');
}
Expand Down
2 changes: 1 addition & 1 deletion common/plotters/PS_plotter.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ std::string PSLIKE_PLOTTER::encodeStringForPlotter( const wxString& aUnicode )

for( unsigned i = 0; i < aUnicode.Len(); i++ )
{
// Lazyness made me use stdio buffering yet another time...
// Laziness made me use stdio buffering yet another time...
wchar_t ch = aUnicode[i];

if( ch < 256 )
Expand Down
Loading

0 comments on commit f968fc8

Please sign in to comment.