[PATCH] Ad-hoc fixes to documentation

Asked by Mikhail Karpenko

I found some misspellings and inconsistencies in comments trying to dive into sources. I think it is better fix them as they go to doxygen generated documentation.

diff --git a/include/kiway.h b/include/kiway.h
index 865c645..d40e853 100644
--- a/include/kiway.h
+++ b/include/kiway.h
@@ -198,7 +198,7 @@ struct KIFACE
      * @param aCtlBits consists of bit flags from the set of KFCTL_* \#defines above.
      *
      * @return wxWindow* - and if not NULL, should be cast into the known type using
- * and old school cast. dynamic_cast is problemenatic since it needs typeinfo probably
+ * and old school cast. dynamic_cast is problematic since it needs typeinfo probably
      * not contained in the caller's link image.
      */
     VTBL_ENTRY wxWindow* CreateWindow( wxWindow* aParent, int aClassId,
@@ -228,7 +228,7 @@ struct KIFACE
  * having to link to the top process module which houses the KIWAY(s). More importantly
  * it makes it possible to send custom wxEvents between DSOs and from the top
  * process module down into the DSOs. The latter capability is thought useful
- * for driving the lower DSOs from a python test rig or for demo (automaton) purposes.
+ * for driving the lower DSOs from a python test rig or for demo (automation) purposes.
  * <p>
  * Most all calls are via virtual functions, which means C++ vtables
  * are used to hold function pointers and eliminate the need to link to specific
diff --git a/include/tool/tool_manager.h b/include/tool/tool_manager.h
index 6f32ce6..469a8c7 100644
--- a/include/tool/tool_manager.h
+++ b/include/tool/tool_manager.h
@@ -52,7 +52,7 @@ public:
     ~TOOL_MANAGER();

     /**
- * Generates an unique ID from for a tool with given name.
+ * Generates a unique ID for a tool with given name.
      */
     static TOOL_ID MakeToolId( const std::string& aToolName );
diff --git a/pcbnew/class_netclass.h b/pcbnew/class_netclass.h
index b80675d..5b6bbe1 100644
--- a/pcbnew/class_netclass.h
+++ b/pcbnew/class_netclass.h
@@ -125,7 +125,7 @@ public:
     }

     /**
- * Function AddMember
+ * Function Add
      * adds \a aNetname to this NETCLASS if it is not already in this NETCLASS.
      * It is harmless to try and add a second identical name.
      */
diff --git a/pcbnew/collectors.cpp b/pcbnew/collectors.cpp
index 23a168f..74a5e38 100644
--- a/pcbnew/collectors.cpp
+++ b/pcbnew/collectors.cpp
@@ -466,7 +466,7 @@ void GENERAL_COLLECTOR::Collect( BOARD_ITEM* aItem, const KICAD_T aScanList[],

     SetTimeNow(); // when snapshot was taken

- // record the length of the primary list before concatonating on to it.
+ // record the length of the primary list before concatenating on to it.
     m_PrimaryLength = m_List.size();

     // append 2nd list onto end of the first list
diff --git a/pcbnew/collectors.h b/pcbnew/collectors.h
index 66432ff..b2d5c9d 100644
--- a/pcbnew/collectors.h
+++ b/pcbnew/collectors.h
@@ -228,7 +228,7 @@ protected:

     /**
      * The number of items that were originally in the primary list before the
- * m_List2nd was concatonated onto the end of it.
+ * m_List2nd was concatenated onto the end of it.
      */
     int m_PrimaryLength;

diff --git a/pcbnew/connect.h b/pcbnew/connect.h
index 830fbde..46868c8 100644
--- a/pcbnew/connect.h
+++ b/pcbnew/connect.h
@@ -107,7 +107,7 @@ public:
     /**
      * Function BuildPadsList
      * Fills m_sortedPads with all pads that be connected to tracks
- * pads are sorted by > then Y coordinates to allow fast binary search in list
+ * pads are sorted by X then Y coordinates to allow fast binary search in list
      * @param aNetcode = net code to use to filter pads
      * if aNetcode < 0, all pads will be put in list (default)
      */
diff --git a/pcbnew/edit_pcb_text.cpp b/pcbnew/edit_pcb_text.cpp
index 8c6e257..682db7a 100644
--- a/pcbnew/edit_pcb_text.cpp
+++ b/pcbnew/edit_pcb_text.cpp
@@ -25,7 +25,7 @@

 /**
  * @file edit_pcb_text.cpp
- * @brief Editimg of text on copper and technical layers (TEXTE_PCB class)
+ * @brief Editing of text on copper and technical layers (TEXTE_PCB class)
  */

 #include <fctsys.h>
diff --git a/pcbnew/tools/pcbnew_control.h b/pcbnew/tools/pcbnew_control.h
index 7eab41b..7bfec22 100644
--- a/pcbnew/tools/pcbnew_control.h
+++ b/pcbnew/tools/pcbnew_control.h
@@ -86,7 +86,7 @@ private:
     ///> Sets up handlers for various events.
     void setTransitions();

- ///> Pointerto the currently used edit frame.
+ ///> Pointer to the currently used edit frame.
     PCB_BASE_FRAME* m_frame;
 };
diff --git a/pcbnew/tools/selection_tool.h b/pcbnew/tools/selection_tool.h
index 1481bd7..3313d63 100644
--- a/pcbnew/tools/selection_tool.h
+++ b/pcbnew/tools/selection_tool.h
@@ -188,7 +188,7 @@ public:
 private:
     /**
      * Function selectCursor()
- * Selects an item pointed by the parameter aWhere. If there is more than one item at that
+ * Selects an item pointed by the parameter \a aWhere. If there is more than one item at that
      * place, there is a menu displayed that allows to choose the item.
      *
      * @param aWhere is the place where the item should be selected.
@@ -225,7 +225,7 @@ private:
     void setTransitions();

     /**
- * Function ClearSelection()
+ * Function clearSelection()
      * Clears the current selection.
      */
     void clearSelection();
@@ -264,23 +264,23 @@ private:
     bool selectable( const BOARD_ITEM* aItem ) const;

     /**
- * Function selectItem()
- * Takes necessary action mark an item as selected.
+ * Function select()
+ * Takes necessary action to mark an item as selected.
      *
      * @param aItem is an item to be selected.
      */
     void select( BOARD_ITEM* aItem );

     /**
- * Function unselectItem()
- * Takes necessary action mark an item as unselected.
+ * Function unselect()
+ * Takes necessary action to mark an item as unselected.
      *
      * @param aItem is an item to be unselected.
      */
     void unselect( BOARD_ITEM* aItem );

     /**
- * Function unselectVisually()
+ * Function selectVisually()
      * Marks item as selected, but does not add it to the ITEMS_PICKED_LIST.
      * @param aItem is an item to be be marked.
      */
@@ -288,16 +288,16 @@ private:

     /**
      * Function unselectVisually()
- * Marks item as selected, but does not add it to the ITEMS_PICKED_LIST.
+ * Marks item as unselected, but does not add it to the ITEMS_PICKED_LIST.
      * @param aItem is an item to be be marked.
      */
     void unselectVisually( BOARD_ITEM* aItem ) const;

     /**
- * Function containsSelected()
+ * Function selectionContains()
      * Checks if the given point is placed within any of selected items' bounding box.
      *
- * @return True if the given point is contained in any of selected items' bouding box.
+ * @return True if the given point is contained in any of selected items' bounding box.
      */
     bool selectionContains( const VECTOR2I& aPoint ) const;

Question information

Language:
English Edit question
Status:
Answered
For:
KiCad Edit question
Assignee:
No assignee Edit question
Last query:
Last reply:
Revision history for this message
Maciej Suminski (orsonmmz) said :
#1

Hi Mikhail,

Thank you for the patch. Some of the fixes you proposed had been already applied, so I have committed the remaining part in revision 5578. Good to know there are people who actually read comments, it feels encouraging.

In case you would like to post some more patches - feel invited to join the developers mailing list [1] and send your changes there. It seems the mailing list patches are processed faster.

Regards,
Orson

1. https://launchpad.net/~kicad-developers

Can you help with this problem?

Provide an answer of your own, or ask Mikhail Karpenko for more information if necessary.

To post a message you must log in.