7
mirror of https://gitlab.com/kicad/code/kicad.git synced 2025-03-30 04:36:54 +00:00

Fix source comment / documentation typos

This commit is contained in:
luz paz 2021-06-09 19:32:58 +00:00 committed by Seth Hillbrand
parent 053bd66650
commit f968fc8719
261 changed files with 422 additions and 422 deletions
.gitignore
3d-viewer
CMakeLists.txt
CMakeModules
bitmap2component
bitmaps_png/icons
common
cvpcb/dialogs
demos/python_scripts_examples
eeschema
gerbview
include
kicad
libs
pagelayout_editor
pcb_calculator
pcbnew
autorouter
board.cppboard_design_settings.cpp
board_stackup_manager
collectors.cpp
connectivity
dialogs
drc
exporters
footprint.cppfootprint_edit_frame.cppfootprint_info_impl.cppfootprint_wizard_frame.cpp
import_gfx
kicad_clipboard.cppload_select_footprint.cpppcb_edit_frame.cpppcb_painter.cpppcbnew.cpppcbplot.cppplot_brditems_plotter.cpp
plugins
python
router
specctra_import_export
tools
tracks_cleaner.cppundo_redo.cppzone_filler.cppzone_filler.hzones_functions_for_undo_redo.cpp
plugins/3d/vrml/v2
qa
scripting
tools
translation
uncrustify.cfg
utils/kicad2step/pcb

2
.gitignore vendored
View File

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

View File

@ -38,7 +38,7 @@
*
* @param aInclination θ [0, π]
* @param aAzimuth φ [0, 2π]
* @return Cartesian cordinates
* @return Cartesian coordinates
*/
inline SFVEC3F SphericalToCartesian( float aInclination, float aAzimuth )
{

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -69,7 +69,7 @@ public:
const SFVEC3F& aN4 );
/**
* Get the array of vertexes.
* Get the array of vertices.
*
* @return a pointer to the start of array vertex.
*/

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

Some files were not shown because too many files have changed in this diff Show More