haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix a few doxygen warnings

This commit is contained in:
jean-pierre charras 2017-06-25 11:26:04 +02:00
parent 1e770f56a6
commit 6a3c1720b2
14 changed files with 28 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
3d-viewer/3d_cache/sg/sg_index.h
View File

@ -83,8 +83,7 @@ public:
* Function AddIndex
* adds a single index to the list
*
* @param nIndices [in] the number of indices to be stored
* @param aIndexList [in] the index data
* @param aIndex is the index to add
*/
void AddIndex( int aIndex );

2
3d-viewer/3d_canvas/cinfo3d_visu.h
View File

@ -387,7 +387,7 @@ class CINFO3D_VISU
/**
* @brief GetNrSegmentsCircle
* @param aDiameter: diameter in 3DU
* @param aDiameter3DU: diameter in 3DU
* @return number of sides that should be used in that circle
*/
unsigned int GetNrSegmentsCircle( float aDiameter3DU ) const;

7
3d-viewer/3d_rendering/3d_render_raytracing/shapes3D/ccylinder.h
View File

@ -41,9 +41,10 @@ class CVCYLINDER : public COBJECT
public:
/**
* Constructor CVCYLINDER
* @param aCenterPoint = position of the center of the plane
* @param aXSize = size by X axis
* @param aYSize = size by Y axis
* @param aCenterPoint = position of the vertical cylinder axis in the XY plane
* @param aZmin = bottom position (Z axis)
* @param aZmax = top position (Z axis)
* @param aRadius = radius of the cylinder
*/
CVCYLINDER( SFVEC2F aCenterPoint, float aZmin, float aZmax, float aRadius );

6
3d-viewer/3d_rendering/3d_render_raytracing/shapes3D/cobject.h
View File

@ -79,15 +79,15 @@ public:
* @brief Intersect
* @param aRay
* @param aHitInfo
* @return TRUE if the aRay intersects the object
* @return true if the aRay intersects the object
*/
virtual bool Intersect( const RAY &aRay, HITINFO &aHitInfo ) const = 0;
/** Functions Intersect for shadow test
* @brief Intersect
* @param aRay
* @param aDistance - max distance of the test
* @return TRUE if the aRay intersects the object
* @param aMaxDistance - max distance of the test
* @return true if the aRay intersects the object
*/
virtual bool IntersectP( const RAY &aRay, float aMaxDistance ) const = 0;

3
include/plugins/3dapi/ifsg_index.h
View File

@ -62,8 +62,7 @@ public:
* Function AddIndex
* adds a single index to the list
*
* @param nIndices [in] the number of indices to be stored
* @param aIndexList [in] the index data
* @param aIndex is the new index to add
*/
bool AddIndex( int aIndex );
};

1
include/plugins/3dapi/ifsg_node.h
View File

@ -141,7 +141,6 @@ public:
* is then typically added to another node via AddRefNode().
*
* @param aNodeName is the name of the node to search for
* @param aCaller is a pointer to the node invoking this function
* @return is a valid node pointer on success, otherwise NULL
*/
SGNODE* FindNode( const char *aNodeName );

2
include/tool/tool_action.h
View File

@ -169,7 +169,7 @@ public:
/**
* Creates a hot key code that refers to a legacy hot key setting, instead of a particular key.
* @param aHotKey is an ID of hot key to be referred (see @hotkeys.h).
* @param aHotKey is an ID of hot key to be referred (see hotkeys.h).
*/
inline static int LegacyHotKey( int aHotKey )
{

2
include/tool/tool_dispatcher.h
View File

@ -55,7 +55,7 @@ public:
* Constructor
*
* @param aToolMgr: tool manager instance the events will be sent to
* @param aActions: ACTIONS subclass instance for ::TranslateLegacyId()
* @param aActions: ACTIONS subclass instance for ACTIONS::TranslateLegacyId()
*/
TOOL_DISPATCHER( TOOL_MANAGER* aToolMgr, ACTIONS *aActions );

2
include/widgets/footprint_choice.h
View File

@ -67,6 +67,7 @@ protected:
/**
* Veto a select event for the separator
*
* @param aEvent - the wxCommandEvent caller
* @param aInner - true if event was called for the inner list (ie the popup)
*/
void TryVetoSelect( wxCommandEvent& aEvent, bool aInner );
@ -84,6 +85,7 @@ protected:
/**
* For arrow key events, skip over separators.
*
* @param aEvent - the wxKeyEvent caller
* @param aInner - true if event was called for the inner list (ie the popup)
*/
void TrySkipSeparator( wxKeyEvent& aEvent, bool aInner );

4
include/widgets/footprint_select_widget.h
View File

@ -95,6 +95,10 @@ public:
/**
* Filter by footprint filter list. Does not update the list.
*
* @param aFilters is a wxArrayString of strings used to filter the list of available
* footprints (can be empty).
* The final fp list is the list of footprint names matching at least one filtering string.
* A filtering string is something like sm0402 or DIP*
* @param aZeroFilters - if true, zero filters = zero footprints. If false, zero filters =
* not filtering.
*/

6
include/wxBasePcbFrame.h
View File

@ -479,9 +479,10 @@ public:
* used only in move footprint. It is not optimal, but it is fast and sufficient
* to help a footprint placement
* It shows the connections from a pad to the nearest connected pad
* @param aMoveVector = move vector of the footprint being moved.
* @param aModule = module to consider.
*/
void build_ratsnest_module( MODULE *mod, wxPoint aMoveVector );
void build_ratsnest_module( MODULE *aModule, wxPoint aMoveVector );
/**
* Function TraceModuleRatsNest
@ -522,8 +523,7 @@ public:
* from the current new track to candidates during track creation
* @param aItemRef = the item connected to the starting point of the new track (track or pad)
* @param aPosition = the position of the new track end (usually the mouse cursor on grid)
* @param aInit = true to build full candidate list or false to update data
* When aInit = false, aItemRef is not used (can be NULL)
* @param aNet = the netcode of the track
*/
void BuildAirWiresTargetsList( BOARD_CONNECTED_ITEM* aItemRef,
const wxPoint& aPosition,

7
pcbnew/clean.cpp
View File

@ -1,9 +1,9 @@
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004-2016 Jean-Pierre Charras, jean-pierre.charras@gpisa-lab.inpg.fr
* Copyright (C) 2004-2017 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2011 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 1992-2016 KiCad Developers, see change_log.txt for contributors.
* Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -49,9 +49,8 @@ public:
/**
* the cleanup function.
* return true if some item was modified
* @param aFrame = the PCB_EDIT_FRAME which handles the board
* @param aRemoveMisConnected = true to remove segments connecting 2 different nets
* @param aCleanVias = true to remove superimposed vias
* @param aRemoveMisConnected = true to remove segments connecting 2 different nets
* @param aMergeSegments = true to merge collinear segmenst and remove 0 len segm
* @param aDeleteUnconnected = true to remove dangling tracks
* (short circuits)

6
pcbnew/ratsnest.cpp
View File

@ -179,14 +179,14 @@ void PCB_BASE_FRAME::BuildAirWiresTargetsList( BOARD_CONNECTED_ITEM* aItemRef,
static MODULE movedModule( nullptr );
void PCB_BASE_FRAME::build_ratsnest_module( MODULE* mod, wxPoint aMoveVector )
void PCB_BASE_FRAME::build_ratsnest_module( MODULE* aModule, wxPoint aMoveVector )
{
auto connectivity = GetBoard()->GetConnectivity();
movedModule = *mod;
movedModule = *aModule;
movedModule.Move( -aMoveVector );
connectivity->ClearDynamicRatsnest();
connectivity->BlockRatsnestItems( { mod } );
connectivity->BlockRatsnestItems( { aModule } );
connectivity->ComputeDynamicRatsnest( { &movedModule } );
}

2
pcbnew/ratsnest_data.h
View File

@ -131,7 +131,7 @@ public:
* Function GetAllItems()
* Adds all stored items to a list.
* @param aOutput is the list that will have items added.
* @param aType determines the type of added items.
* @param aTypes determines the type of added items.
*/
void GetAllItems( std::list<BOARD_CONNECTED_ITEM*>& aOutput, const KICAD_T aTypes[] ) const;