Fix many doxygen warnings (due to missing info, old comments, typo ...) when building the doxygen doc.

Doxyfile

@@ -690,7 +690,7 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = include/boost
+EXCLUDE                = polygon/clipper.cpp
 
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or

common/class_bitmap_base.cpp

@@ -1,5 +1,5 @@
 /**
- * @file sch_bitmap.cpp
+ * @file class_bitmap_base.cpp
  */
 
 /*

common/project.cpp

@@ -93,6 +93,11 @@ const wxString PROJECT::GetProjectFullName() const
     return m_project_name.GetFullPath();
 }
 
+const wxString PROJECT::GetProjectPath() const
+{
+    return m_project_name.GetPathWithSep();
+}
+
 
 const wxString PROJECT::FootprintLibTblName() const
 {
@@ -248,10 +253,10 @@ static bool copy_pro_file_template( const SEARCH_STACK& aSearchS, const wxString
 
 
 wxConfigBase* PROJECT::configCreate( const SEARCH_STACK& aSList,
-        const wxString& aGroupName, const wxString& aFileName )
+        const wxString& aGroupName, const wxString& aProjectFileName )
 {
     wxConfigBase*   cfg = 0;
-    wxString        cur_pro_fn = !aFileName ? GetProjectFullName() : aFileName;
+    wxString        cur_pro_fn = !aProjectFileName ? GetProjectFullName() : aProjectFileName;
 
     if( wxFileName( cur_pro_fn ).IsFileReadable() )
     {

eeschema/class_library.h

@@ -121,8 +121,6 @@ public:
      * allocates and adds a part library to the library list.
      *
      * @param aFileName - File name object of part library.
-     * @param aErrorMsg - Error message if the part library failed to load.
-     * @return PART_LIB* - the new PART_LIB, which remains owned by this PART_LIBS container.
      * @throw IO_ERROR if there's any problem loading.
      */
     PART_LIB* AddLibrary( const wxString& aFileName ) throw( IO_ERROR );
@@ -136,7 +134,8 @@ public:
      * @return PART_LIB* - the new PART_LIB, which remains owned by this PART_LIBS container.
      * @throw IO_ERROR if there's any problem loading.
      */
-    PART_LIB* AddLibrary( const wxString& aFileName, PART_LIBS::iterator& aIterator ) throw( IO_ERROR );
+    PART_LIB* AddLibrary( const wxString& aFileName,
+                          PART_LIBS::iterator& aIterator ) throw( IO_ERROR );
 
     /**
      * Function RemoveLibrary

eeschema/component_tree_search_container.h

@@ -97,7 +97,7 @@ public:
 
     /** Function GetSelectedAlias
      *
-     * @param if not-NULL, the selected sub-unit is set here.
+     * @param aUnit : if not NULL, the selected sub-unit is set here.
      * @return the selected alias or NULL if there is none, or there is no tree.
      */
     LIB_ALIAS* GetSelectedAlias( int* aUnit );

eeschema/dialogs/dialog_plot_schematic.cpp

@@ -36,6 +36,7 @@
 #include <class_sch_screen.h>
 #include <wxEeschemaStruct.h>
 #include <base_units.h>
+#include <sch_sheet.h>
 #include <dialog_plot_schematic.h>
 
 // Keys for configuration
@@ -183,8 +184,7 @@ void DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked( wxCommandEvent& even
     if( dialog.ShowModal() == wxID_YES )
     {
 
-        wxString plotFilePath = m_parent->GetUniqueFilenameForCurrentSheet() + wxT( "." )
-                       + PS_PLOTTER::GetDefaultFileExtension();
+        wxString plotFilePath = g_RootSheet->GetFileName();
 
         plotFilePath = Prj().AbsolutePath(plotFilePath);
         plotFilePath = wxPathOnly( plotFilePath );

eeschema/dialogs/dialog_plot_schematic_base.cpp

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version Sep 11 2014)
+// C++ code generated with wxFormBuilder (version Jun  5 2014)
 // http://www.wxformbuilder.org/
 //
 // PLEASE DO "NOT" EDIT THIS FILE!
@@ -28,7 +28,7 @@ DIALOG_PLOT_SCHEMATIC_BASE::DIALOG_PLOT_SCHEMATIC_BASE( wxWindow* parent, wxWind
 	
 	m_outputDirectoryName = new wxTextCtrl( this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, 0 );
 	m_outputDirectoryName->SetMaxLength( 0 ); 
-	m_outputDirectoryName->SetToolTip( _("Target directory for plot files. Can be absolute or relative to the schematic file location.") );
+	m_outputDirectoryName->SetToolTip( _("Target directory for plot files. Can be absolute or relative to the schematic main file location.") );
 	
 	bSizer5->Add( m_outputDirectoryName, 1, wxALIGN_CENTER_VERTICAL|wxEXPAND|wxLEFT|wxRIGHT, 5 );
 	

eeschema/dialogs/dialog_plot_schematic_base.fbp

@@ -247,7 +247,7 @@
                                         <property name="style"></property>
                                         <property name="subclass"></property>
                                         <property name="toolbar_pane">0</property>
-                                        <property name="tooltip">Target directory for plot files. Can be absolute or relative to the schematic file location.</property>
+                                        <property name="tooltip">Target directory for plot files. Can be absolute or relative to the schematic main file location.</property>
                                         <property name="validator_data_type"></property>
                                         <property name="validator_style">wxFILTER_NONE</property>
                                         <property name="validator_type">wxDefaultValidator</property>

eeschema/dialogs/dialog_plot_schematic_base.h

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version Sep 11 2014)
+// C++ code generated with wxFormBuilder (version Jun  5 2014)
 // http://www.wxformbuilder.org/
 //
 // PLEASE DO "NOT" EDIT THIS FILE!

eeschema/libeditframe.h

@@ -431,6 +431,7 @@ private:
      * Any changes are updated in memory only and NOT to a file.  The old component is
      * deleted from the library and/or any aliases before the edited component is updated
      * in the library.
+     * @param aLib - the part library where the part must be saved.
      * @param aPromptUser true to ask for confirmation, when the part_lib is already existing
      *      in memory, false to save silently
      * @return true if the part was saved, false if aborted by user

eeschema/sch_sheet_path.h

@@ -211,6 +211,7 @@ public:
     /**
      * Function AnnotatePowerSymbols
      * annotates the power symbols only starting at \a aReference in the sheet path.
+     * @param aLibs the library list to use
      * @param aReference A pointer to the number for the reference designator of the
      *                   first power symbol to be annotated.  If the pointer is NULL
      *                   the annotation starts at 1.  The number is incremented for
@@ -221,10 +222,12 @@ public:
     /**
      * Function GetComponents
      * adds a SCH_REFERENCE() object to \a aReferences for each component in the sheet.
+     * @param aLibs the library list to use
      * @param aReferences List of references to populate.
-     * @param aIncludePowerSymbols Set to false to only get normal components.
+     * @param aIncludePowerSymbols : false to only get normal components.
      */
-    void GetComponents( PART_LIBS* aLibs, SCH_REFERENCE_LIST& aReferences, bool aIncludePowerSymbols = true  );
+    void GetComponents( PART_LIBS* aLibs, SCH_REFERENCE_LIST& aReferences,
+                        bool aIncludePowerSymbols = true  );
 
     /**
      * Function SetFootprintField
@@ -391,6 +394,7 @@ public:
     /**
      * Function AnnotatePowerSymbols
      * clear and annotates the entire hierarchy of the sheet path list.
+     * @param aLib the library list to use
      */
     void AnnotatePowerSymbols( PART_LIBS* aLib );
 
@@ -398,6 +402,7 @@ public:
      * Function GetComponents
      * adds a SCH_REFERENCE() object to \a aReferences for each component in the list
      * of sheets.
+     * @param aLibs the library list to use
      * @param aReferences List of references to populate.
      * @param aIncludePowerSymbols Set to false to only get normal components.
      */

eeschema/viewlib_frame.h

@@ -49,8 +49,11 @@ public:
 
     /**
      * Constructor
+     * @param aKiway
+     * @param aParent = the parent frame
      * @param aFrameType must be given either FRAME_SCH_LIB_VIEWER or
      *  FRAME_SCH_LIB_VIEWER_MODAL
+     * @param aLibrary = the library to open when starting (default = NULL)
      */
     LIB_VIEW_FRAME( KIWAY* aKiway, wxWindow* aParent,
             FRAME_T aFrameType, PART_LIB* aLibrary = NULL );
@@ -115,10 +118,11 @@ public:
     /**
      * Set the selected component.
      *
-     * @param the alias name of the component to be selected.
+     * @param aComponentName : the name of the component to be selected.
      */
     void SetSelectedComponent( const wxString& aComponentName );
 
+    // Accessors:
     void SetUnit( int aUnit ) { m_unit = aUnit; }
     int GetUnit( void ) { return m_unit; }
 

include/colors.h

@@ -163,7 +163,7 @@ EDA_COLOR_T ColorFindNearest( const wxColour &aColor );
  * Find the nearest color match
  * @param aR is the red component of the color to be matched (in range 0-255)
  * @param aG is the green component of the color to be matched (in range 0-255)
- * @param aG is the blue component of the color to be matched (in range 0-255)
+ * @param aB is the blue component of the color to be matched (in range 0-255)
  */
 EDA_COLOR_T ColorFindNearest( int aR, int aG, int aB );
 

include/common.h

@@ -584,8 +584,8 @@ void SystemDirsAppend( SEARCH_STACK* aSearchStack );
  * <p>
  * Return the KiCad help file with path and extension.
  * Help files can be html (.html ext) or pdf (.pdf ext) files.
- * A <BaseName>.html file is searched and if not found,
- * <BaseName>.pdf file is searched in the same path.
+ * A \<BaseName\>.html file is searched and if not found,
+ * \<BaseName\>.pdf file is searched in the same path.
  * If the help file for the current locale is not found, an attempt to find
  * the English version of the help file is made.
  * Help file is searched in directories in this order:

include/gal/color4d.h

@@ -199,9 +199,9 @@ public:
      * Function FromHSV()
      * Changes currently used color to the one given by hue, saturation and value parameters.
      *
-     * @param aOutH is hue component.
-     * @param aOutS is saturation component.
-     * @param aOutV is value component.
+     * @param aInH is hue component.
+     * @param aInS is saturation component.
+     * @param aInV is value component.
      */
     void FromHSV( double aInH, double aInS, double aInV );
 

include/gal/opengl/noncached_container.h

@@ -44,13 +44,13 @@ public:
     NONCACHED_CONTAINER( unsigned int aSize = defaultInitSize );
     virtual ~NONCACHED_CONTAINER();
 
-    ///< @copydoc VERTEX_CONTAINER::SetItem()
+    ///< @copydoc VERTEX_CONTAINER::SetItem( VERTEX_ITEM* aItem )
     virtual void SetItem( VERTEX_ITEM* aItem );
 
-    ///< @copydoc VERTEX_CONTAINER::Allocate()
+    ///< @copydoc VERTEX_CONTAINER::Allocate( unsigned int aSize )
     virtual VERTEX* Allocate( unsigned int aSize );
 
-    ///< @copydoc VERTEX_CONTAINER::Delete()
+    ///< @copydoc VERTEX_CONTAINER::Delete( VERTEX_ITEM* aItem )
     void Delete( VERTEX_ITEM* aItem ) {};
 
     ///< @copydoc VERTEX_CONTAINER::Clear()

include/gal/opengl/vertex_container.h

@@ -99,7 +99,7 @@ public:
     /**
      * Function GetVertices()
      * returns vertices stored at the specific offset.
-     * @aOffset is the offset.
+     * @param aOffset is the offset.
      */
     virtual inline VERTEX* GetVertices( unsigned int aOffset ) const
     {

include/gal/opengl/vertex_item.h

@@ -50,7 +50,7 @@ public:
     /**
      * Function GetSize()
      * Returns information about number of vertices stored.
-     * @param Number of vertices.
+     * @return Number of vertices.
      */
     inline unsigned int GetSize() const
     {
@@ -69,7 +69,7 @@ public:
 
     /**
      * Function GetVertices()
-     * Returns pointer to the data used by the VERTEX_ITEM.
+     * areturn a pointer to the data used by the VERTEX_ITEM.
      */
     VERTEX* GetVertices() const;
 

include/geometry/rtree.h

@@ -123,7 +123,6 @@ public:
     /// Find all within search rectangle
     /// \param a_min Min of search bounding rect
     /// \param a_max Max of search bounding rect
-    /// \param a_searchResult Search result array.  Caller should set grow size. Function will reset, not append to array.
     /// \param a_resultCallback Callback function to return result.  Callback should return 'true' to continue searching
     /// \param a_context User context to pass as parameter to a_resultCallback
     /// \return Returns the number of entries found

include/geometry/shape.h

@@ -112,8 +112,8 @@ public:
      * @param aMTV minimum translation vector
      * @return true, if there is a collision.
      */
-    virtual bool Collide( const SHAPE* aShape, int aClerance, VECTOR2I& aMTV ) const;
-    virtual bool Collide( const SHAPE* aShape, int aClerance = 0 ) const;
+    virtual bool Collide( const SHAPE* aShape, int aClearance, VECTOR2I& aMTV ) const;
+    virtual bool Collide( const SHAPE* aShape, int aClearance = 0 ) const;
 
     /**
      * Function Collide()
@@ -129,7 +129,7 @@ public:
      *
      * Computes a bounding box of the shape, with a margin of aClearance
      * a collision.
-     * @aClearance how much the bounding box is expanded wrs to the minimum enclosing rectangle
+     * @param aClearance how much the bounding box is expanded wrs to the minimum enclosing rectangle
      * for the shape.
      * @return the bounding box.
      */

include/geometry/shape_index.h

@@ -37,7 +37,7 @@
  * It is used by SHAPE_INDEX to get a SHAPE* from another type.
  * By default relies on T::GetShape() method, should be specialized if the T object
  * doesn't allow that method.
- * @param object generic T object
+ * @param aItem generic T object
  * @return a SHAPE* object equivalent to object.
  */
 template <class T>
@@ -59,7 +59,7 @@ const SHAPE* shapeFunctor( SHAPE* aItem );
  * It is used by SHAPE_INDEX to get the bounding box of a generic T object.
  * By default relies on T::BBox() method, should be specialized if the T object
  * doesn't allow that method.
- * @param object generic T object
+ * @param aObject generic T object
  * @return a BOX2I object containing the bounding box of the T object.
  */
 template <class T>
@@ -75,8 +75,8 @@ BOX2I boundingBox( T aObject )
  * It is used by SHAPE_INDEX to implement Accept().
  * By default relies on V::operation() redefinition, should be specialized if V class
  * doesn't have its () operation defined to accept T objects.
- * @param object generic T object
- * @param visitor V visitor object
+ * @param aObject generic T object
+ * @param aVisitor V visitor object
  */
 template <class T, class V>
 void acceptVisitor( T aObject, V aVisitor )
@@ -91,9 +91,9 @@ void acceptVisitor( T aObject, V aVisitor )
  * It is used by SHAPE_INDEX to implement Query().
  * By default relies on T::Collide(U) method, should be specialized if the T object
  * doesn't allow that method.
- * @param object generic T object
- * @param anotherObject generic U object
- * @param minDistance minimum collision distance
+ * @param aObject generic T object
+ * @param aAnotherObject generic U object
+ * @param aMinDistance minimum collision distance
  * @return if object and anotherObject collide
  */
 template <class T, class U>
@@ -126,7 +126,7 @@ class SHAPE_INDEX
              * Function Init()
              *
              * Setup the internal tree iterator.
-             * @param tree pointer to a RTREE object
+             * @param aTree pointer to a RTREE object
              */
             void Init( RTree<T, int, 2, float>* aTree )
             {
@@ -138,7 +138,7 @@ class SHAPE_INDEX
              * Iterator constructor
              *
              * Creates an iterator for the index object
-             * @param index SHAPE_INDEX object to iterate
+             * @param aIndex SHAPE_INDEX object to iterate
              */
             Iterator( SHAPE_INDEX* aIndex )
             {
@@ -244,7 +244,7 @@ class SHAPE_INDEX
          * Function Accept()
          *
          * Accepts a visitor for every SHAPE object contained in this INDEX.
-         * @param visitor Visitor object to be run
+         * @param aVisitor Visitor object to be run
          */
         template <class V>
         void Accept( V aVisitor )
@@ -271,9 +271,9 @@ class SHAPE_INDEX
          * Function Query()
          *
          * Runs a callback on every SHAPE object contained in the bounding box of (shape).
-         * @param shape shape to search against
-         * @param minDistance distance threshold
-         * @param visitor object to be invoked on every object contained in the search area.
+         * @param aShape shape to search against
+         * @param aMinDistance distance threshold
+         * @param aVisitor object to be invoked on every object contained in the search area.
          */
         template <class V>
         int Query( const SHAPE *aShape, int aMinDistance, V& aVisitor, bool aExact )

include/geometry/shape_line_chain.h

@@ -270,7 +270,7 @@ public:
      * Function Collide()
      *
      * Checks if box aBox lies closer to us than aClearance.
-     * @param aP the box to check for collisions with
+     * @param aBox the box to check for collisions with
      * @param aClearance minimum distance that does not qualify as a collision.
      * @return true, when a collision has been found
      */

include/math/matrix3x3.h

@@ -78,12 +78,12 @@ public:
      * @param a00 is the component [0,0].
      * @param a01 is the component [0,1].
      * @param a02 is the component [0,2].
+     * @param a10 is the component [1,0].
      * @param a11 is the component [1,1].
      * @param a12 is the component [1,2].
-     * @param a13 is the component [1,3].
      * @param a20 is the component [2,0].
      * @param a21 is the component [2,1].
-     * @param a00 is the component [2,2].
+     * @param a22 is the component [2,2].
      */
     MATRIX3x3( T a00, T a01, T a02, T a10, T a11, T a12, T a20, T a21, T a22 );
 

include/painter.h

@@ -133,7 +133,7 @@ public:
      * Function SetHighlight
      * Turns on/off highlighting - it may be done for the active layer or the specified net.
      * @param aEnabled tells if highlighting should be enabled.
-     * @param aNetCode is optional and if specified, turns on higlighting only for the net with
+     * @param aNetcode is optional and if specified, turns on higlighting only for the net with
      * number given as the parameter.
      */
     inline void SetHighlight( bool aEnabled, int aNetcode = -1 )
@@ -180,7 +180,7 @@ public:
     /**
      * Function TranslateColor
      * Returns the color responding to the one of EDA_COLOR_T enum values.
-     * @param EDA_COLOR_T color equivalent.
+     * @param aColor equivalent.
      */
     inline const COLOR4D& TranslateColor( EDA_COLOR_T aColor )
     {

include/profile.h

@@ -68,8 +68,8 @@ struct prof_counter
 /**
  * Function prof_start
  * Begins code execution time counting for a given profiling counter.
- * @param cnt is the counter which should be started.
- * @param use_rdtsc tells if processor's time-stamp counter should be used for time counting.
+ * @param aCnt is the counter which should be started.
+ * use_rdtsc tells if processor's time-stamp counter should be used for time counting.
  *      Otherwise is system tics method will be used. IMPORTANT: time-stamp counter should not
  *      be used on multicore machines executing threaded code.
  */
@@ -81,7 +81,7 @@ static inline void prof_start( prof_counter* aCnt )
 /**
  * Function prof_stop
  * Ends code execution time counting for a given profiling counter.
- * @param cnt is the counter which should be stopped.
+ * @param aCnt is the counter which should be stopped.
  */
 static inline void prof_end( prof_counter* aCnt )
 {