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:
parent
053bd66650
commit
f968fc8719
.gitignore
3d-viewer
3d_math.h
CMakeLists.txt3d_rendering
3d_render_raytracing
legacy
test_cases.cpptrackball.h3d_viewer
common_ogl
credits.txtCMakeModules
BuildSteps
FindwxWidgets.cmakeGetPrerequisites.cmakeKiCadVersion.cmakeUsewxWidgets.cmakeconfig.h.cmakebitmap2component
bitmaps_png/icons
common
dialogs
eda_base_frame.cppeda_dde.cppeda_rect.cppgal/opengl
gbr_metadata.cppgr_basic.cppkiway_express.cppkiway_player.cppplotters
preview_items
richio.cppstatus_popup.cpptool
view
widgets
wildcards_and_files_ext.cppcvpcb/dialogs
demos/python_scripts_examples
eeschema
default_values.hproject_rescue.cppsch_edit_frame.cppsch_edit_frame.hsch_file_versions.hsch_reference_list.hsch_screen.cppsch_screen.hsch_sheet_path.cppsch_sheet_path.hsch_text.cppschematic_settings.cpp
dialogs
dialog_edit_one_field.hdialog_pin_properties.cppdialog_sheet_properties.cppdialog_spice_model.cppdialog_symbol_remap.cpppanel_eeschema_template_fieldnames.h
general.hgetpart.cpphierarch.cpplib_item.hlib_symbol.cpplib_symbol.hplugins
python_scripts
xsl_scripts
sch_plugins
cadstar
eagle
kicad
legacy
sim
symbol_viewer_frame.cpptools
transform.hwidgets
gerbview
X2_gerber_attributes.cppam_param.ham_primitive.cppexcellon_image.hexcellon_read_drill_file.cppexport_to_pcbnew.cppgerber_draw_item.cppgerber_file_image.cpprs274_read_XY_and_IJ_coordinates.cpprs274x.cpp
widgets
include
basic_gal.hbitmap_store.h
bitmaps
convert_to_biu.hdialogs
drawing_sheet
gal
gbr_netlist_metadata.hid.hki_exception.hkicad_curl
kiway_player.hlayers_id_colors_and_visibility.hlib_tree_model.hlibeval
plugins/3dapi
preview_items
settings
template_fieldnames.htool
undo_redo_container.hutf8.hwidgets
kicad
libs
kimath
include
geometry
math
src
kiplatform
pagelayout_editor
pcb_calculator
pcbnew
autorouter
board.cppboard_design_settings.cppboard_stackup_manager
collectors.cppconnectivity
dialogs
dialog_drc.cppdialog_export_step_base.hdialog_footprint_checker.cppdialog_footprint_properties_fp_editor.cppdialog_gencad_export_options.cppdialog_net_inspector.cppdialog_pad_properties.cppdialog_track_via_properties.cpp
drc
exporters
export_gencad.cppexporter_vrml.hgen_footprints_placefile.cppgendrill_Excellon_writer.cppgendrill_gerber_writer.cppgerber_jobfile_writer.cppgerber_jobfile_writer.hgerber_placefile_writer.cpp
footprint.cppfootprint_edit_frame.cppfootprint_info_impl.cppfootprint_wizard_frame.cppimport_gfx
kicad_clipboard.cppload_select_footprint.cpppcb_edit_frame.cpppcb_painter.cpppcbnew.cpppcbplot.cppplot_brditems_plotter.cppplugins
altium
cadstar
geda
legacy
pcad
python
plugins
scripting
swig
router
pns_debug_decorator.hpns_diff_pair.hpns_dragger.cpppns_item.cpppns_line_placer.hpns_meander.hpns_optimizer.cpppns_placement_algo.h
specctra_import_export
tools
board_editor_control.cppdrawing_stackup_table_tool.cppdrawing_tool.cppedit_tool.cpppcb_editor_conditions.hpcb_selection_tool.cppzone_create_helper.cpp
tracks_cleaner.cppundo_redo.cppzone_filler.cppzone_filler.hzones_functions_for_undo_redo.cppplugins/3d/vrml/v2
qa
eeschema
data/eagle_schematics
eeschema_test_utils.htest_lib_part.cpptest_sch_sheet_list.cpptest_sch_symbol.cppuuid_test_utils.cpplibs/kimath/geometry
pcbnew/drc
pcbnew_utils
qa_utils
resources/linux
scripting
tools
translation
uncrustify.cfgutils/kicad2step/pcb
2
.gitignore
vendored
2
.gitignore
vendored
@ -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
|
||||
|
@ -38,7 +38,7 @@
|
||||
*
|
||||
* @param aInclination θ ∈ [0, π]
|
||||
* @param aAzimuth φ ∈ [0, 2π]
|
||||
* @return Cartesian cordinates
|
||||
* @return Cartesian coordinates
|
||||
*/
|
||||
inline SFVEC3F SphericalToCartesian( float aInclination, float aAzimuth )
|
||||
{
|
||||
|
@ -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"
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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/
|
||||
*/
|
||||
|
||||
|
@ -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/
|
||||
*/
|
||||
|
@ -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 );
|
||||
}
|
||||
|
||||
|
@ -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 );
|
||||
}
|
||||
|
||||
|
@ -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 )
|
||||
{
|
||||
|
@ -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.
|
||||
*/
|
||||
|
@ -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 );
|
||||
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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/
|
||||
|
||||
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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}")
|
||||
|
@ -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.
|
||||
|
||||
::
|
||||
|
||||
|
@ -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}" )
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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;
|
||||
|
@ -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
Loading…
Reference in New Issue
Block a user