Browse Source

Fix a few doxygen errors (no actual code change)

newinvert
jean-pierre charras 3 years ago
parent
commit
1406341d2d
  1. 2
      3d-viewer/3d_canvas/create_3Dgraphic_brd_items.cpp
  2. 2
      3d-viewer/3d_model_viewer/eda_3d_model_viewer.h
  3. 3
      3d-viewer/3d_rendering/opengl/3d_model.cpp
  4. 2
      3d-viewer/3d_rendering/raytracing/accelerators/bvh_pbrt.cpp
  5. 3
      3d-viewer/3d_rendering/raytracing/shapes3D/cylinder_3d.cpp
  6. 3
      3d-viewer/3d_rendering/raytracing/shapes3D/object_3d.cpp
  7. 2
      3d-viewer/3d_rendering/track_ball.cpp
  8. 2
      3d-viewer/3d_viewer/eda_3d_viewer_frame.h
  9. 2
      common/string_utils.cpp
  10. 2
      cvpcb/listbox_base.cpp
  11. 2
      cvpcb/symbols_listbox.cpp
  12. 2
      eeschema/sch_reference_list.cpp
  13. 5
      gerbview/dialogs/dialog_layers_select_to_pcb.cpp
  14. 2
      gerbview/dialogs/dialog_layers_select_to_pcb.h
  15. 4
      include/dialogs/dialog_color_picker.h
  16. 2
      include/kiway_holder.h
  17. 2
      include/pcb_group.h
  18. 4
      include/view/zoom_controller.h
  19. 8
      include/widgets/mathplot.h
  20. 2
      kicad/project_tree_pane.h
  21. 2
      pcbnew/board_stackup_manager/dialog_dielectric_list_manager.h
  22. 2
      pcbnew/dialogs/dialog_enum_pads.h
  23. 4
      pcbnew/netlist_reader/legacy_netlist_reader.cpp
  24. 2
      pcbnew/pad.cpp
  25. 2
      pcbnew/plugins/altium/altium_circuit_maker_plugin.cpp
  26. 2
      pcbnew/plugins/altium/altium_circuit_studio_plugin.cpp
  27. 2
      pcbnew/plugins/altium/altium_designer_plugin.cpp
  28. 2
      pcbnew/plugins/pcad/pcad_cutout.cpp
  29. 2
      pcbnew/python/scripting/pcbnew_scripting.cpp
  30. 2
      pcbnew/zone_settings.h

2
3d-viewer/3d_canvas/create_3Dgraphic_brd_items.cpp

@ -23,7 +23,7 @@
*/
/**
* @file create_graphic_brd_items.cpp
* @file create_3Dgraphic_brd_items.cpp
* @brief This file implements the creation of 2D graphic primitives of pcb items:
* pads, tracks, drawsegments, texts....
* It is based on the function found in the files:

2
3d-viewer/3d_model_viewer/eda_3d_model_viewer.h

@ -23,7 +23,7 @@
*/
/**
* @file c3d_model_viewer.h
* @file eda_3d_model_viewer.h
* @brief Implements a model viewer canvas.
*
* The purpose of model viewer is to render 3d models that come in the original data from

3
3d-viewer/3d_rendering/opengl/3d_model.cpp

@ -24,8 +24,7 @@
*/
/**
* @file c_ogl_3dmodel.cpp
* @brief
* @file 3d_model.cpp
*/
#include <algorithm>
#include <stdexcept>

2
3d-viewer/3d_rendering/raytracing/accelerators/bvh_pbrt.cpp

@ -23,7 +23,7 @@
*/
/**
* @file cbvh_pbrt.cpp
* @file bvh_pbrt.cpp
* @brief This BVH implementation is based on the source code implementation
* from the book "Physically Based Rendering" (v2 and v3)
*

3
3d-viewer/3d_rendering/raytracing/shapes3D/cylinder_3d.cpp

@ -23,8 +23,7 @@
*/
/**
* @file ccylinder.cpp
* @brief
* @file cylinder_3d.cpp
*/
#include "3d_fastmath.h"

3
3d-viewer/3d_rendering/raytracing/shapes3D/object_3d.cpp

@ -23,8 +23,7 @@
*/
/**
* @file cobject.cpp
* @brief
* @file object_3d.cpp
*/
#include "object_3d.h"

2
3d-viewer/3d_rendering/track_ball.cpp

@ -23,7 +23,7 @@
*/
/**
* @file ctrack_ball.cpp
* @file track_ball.cpp
* @brief Implementation of a track ball camera. A track ball is placed in the
* center of the screen and rotates the camera.
*/

2
3d-viewer/3d_viewer/eda_3d_viewer_frame.h

@ -25,7 +25,7 @@
*/
/**
* @file eda_3d_viewer.h
* @file eda_3d_viewer_frame.h
* @brief Declaration of the eda_3d_viewer class
*/

2
common/string_utils.cpp

@ -22,7 +22,7 @@
*/
/**
* @file string.cpp
* @file string_utils.cpp
* @brief Some useful functions to handle strings.
*/

2
cvpcb/listbox_base.cpp

@ -22,7 +22,7 @@
*/
/**
* @file listboxes.cpp
* @file listbox_base.cpp
* @brief Implementation of class for displaying footprint and symbol lists.
*/

2
cvpcb/symbols_listbox.cpp

@ -22,7 +22,7 @@
*/
/**
* @file class_components_listbox.cpp
* @file symbols_listbox.cpp
*/
#include <trace_helpers.h>

2
eeschema/sch_reference_list.cpp

@ -24,7 +24,7 @@
*/
/**
* @file component_references_lister.cpp
* @file sch_reference_list.cpp
* @brief functions to create a symbol flat list and to annotate schematic.
*/

5
gerbview/dialogs/dialog_layers_select_to_pcb.cpp

@ -1,8 +1,3 @@
/**
* @file select_layers_to_pcb.cpp
* @brief Dialog to choose equivalence between gerber layers and pcb layers
*/
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*

2
gerbview/dialogs/dialog_layers_select_to_pcb.h

@ -23,7 +23,7 @@
*/
/**
* @file select_layers_to_pcb.h
* @file dialog_layers_select_to_pcb.h
*/
#ifndef DIALOG_LAYERS_SELECT_TO_PCB_H_

4
include/dialogs/dialog_color_picker.h

@ -1,7 +1,3 @@
/**
* @file color4Dpickerdlg.h
*/
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*

2
include/kiway_holder.h

@ -75,7 +75,7 @@ public:
* a KIWAY_HOLDER mix-in.
*
* @param aDest is the recipient of \a aKiway pointer.
* @param aKiway is often from a parent window or from #KIFACE::CreateWindow().
* @param aKiway is often from a parent window or from #KIFACE::CreateKiWindow().
*/
void SetKiway( wxWindow* aDest, KIWAY* aKiway );

2
include/pcb_group.h

@ -23,7 +23,7 @@
*/
/**
* @file class_pcb_group.h
* @file pcb_group.h
* @brief Class to handle a set of BOARD_ITEMs.
*/

4
include/view/zoom_controller.h

@ -23,7 +23,7 @@
*/
/**
* @file zoom_control.h
* @file zoom_controller.h
* @brief ZOOM_CONTROLLER class definition.
*/
@ -135,7 +135,7 @@ private:
/**
* A #ZOOM_CONTROLLER that zooms by a fixed factor based only on the magnitude of the scroll
* A CONSTANT_ZOOM_CONTROLLER that zooms by a fixed factor based only on the magnitude of the scroll
* wheel rotation.
*/
class CONSTANT_ZOOM_CONTROLLER : public ZOOM_CONTROLLER

8
include/widgets/mathplot.h

@ -13,7 +13,6 @@
#ifndef _MP_MATHPLOT_H_
#define _MP_MATHPLOT_H_
/** @file mathplot.h */
/**
* wxMathPlot is a framework for mathematical graph plotting in wxWindows.
*
@ -51,6 +50,11 @@
* Jose Luis Blanco, Val Greene.<br>
*/
/**
* @file mathplot.h
*/
// this definition uses windows dll to export function.
// WXDLLIMPEXP_MATHPLOT definition definition changed to WXDLLIMPEXP_MATHPLOT
// mathplot_EXPORTS will be defined by cmake
@ -2032,6 +2036,4 @@ protected:
double m_min_x, m_max_x, m_min_y, m_max_y;
};
/*@}*/
#endif // _MP_MATHPLOT_H_

2
kicad/project_tree_pane.h

@ -23,7 +23,7 @@
*/
/**
* @file PROJECT_TREE_PANE.h
* @file project_tree_pane.h
*/

2
pcbnew/board_stackup_manager/dialog_dielectric_list_manager.h

@ -19,7 +19,7 @@
*/
/**
* @file dialog_dielectric_manager.h
* @file dialog_dielectric_list_manager.h
*/
#ifndef DIALOG_DIELECTRIC_MANAGER_H

2
pcbnew/dialogs/dialog_enum_pads.h

@ -28,7 +28,7 @@
#define __dialog_enum_pads__
/**
* @file Subclass of DIALOG_ENUM_PADS_BASE which is generated by wxFormBuilder.
* @file dialog_enum_pads.h
*/
#include "dialog_enum_pads_base.h"

4
pcbnew/netlist_reader/legacy_netlist_reader.cpp

@ -1,7 +1,3 @@
/**
* @file pcbnew/legacy_netlist_reader.cpp
*/
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*

2
pcbnew/pad.cpp

@ -851,7 +851,7 @@ int PAD::GetSolderMaskExpansion() const
{
// Pads defined only on mask layers (and perhaps on other tech layers) use the shape
// defined by the pad settings only
if( !IsOnCopperLayer() )
if( !IsOnCopperLayer() && !HasHole() )
return 0;
int margin = m_localSolderMaskMargin;

2
pcbnew/plugins/altium/altium_circuit_maker_plugin.cpp

@ -23,7 +23,7 @@
*/
/**
* @file altium_plugin.cpp
* @file altium_circuit_maker_plugin.cpp
* @brief Pcbnew PLUGIN for Altium *.PcbDoc format.
*/

2
pcbnew/plugins/altium/altium_circuit_studio_plugin.cpp

@ -23,7 +23,7 @@
*/
/**
* @file altium_plugin.cpp
* @file altium_circuit_studio_plugin.cpp
* @brief Pcbnew PLUGIN for Altium *.PcbDoc format.
*/

2
pcbnew/plugins/altium/altium_designer_plugin.cpp

@ -23,7 +23,7 @@
*/
/**
* @file altium_plugin.cpp
* @file altium_designer_plugin.cpp
* @brief Pcbnew PLUGIN for Altium *.PcbDoc format.
*/

2
pcbnew/plugins/pcad/pcad_cutout.cpp

@ -24,7 +24,7 @@
*/
/**
* @file pcb_cutout.cpp
* @file pcad_cutout.cpp
*/
#include <pcad/pcad_cutout.h>

2
pcbnew/python/scripting/pcbnew_scripting.cpp

@ -23,7 +23,7 @@
*/
/**
* @file python_scripting.cpp
* @file pcbnew_scripting.cpp
* @brief methods to add scripting capabilities inside pcbnew
*/

2
pcbnew/zone_settings.h

@ -23,7 +23,7 @@
*/
/**
* @file class_zone_settings.h
* @file zone_settings.h
* @brief Class ZONE_SETTINGS used to handle zones parameters in dialogs.
*/

Loading…
Cancel
Save