Road map and Doxygen work.
* Remove obsolete settings from Doxygen configuration file. * Fix some Doxygen warnings. * Add the board edge segment snapping to developers road map. * Fix some coding style issues in CMakeLists.txt
This commit is contained in:
parent
94f8c2a276
commit
99f30c9d38
|
@ -682,7 +682,7 @@ add_dependencies( pl_editor boost )
|
||||||
add_dependencies( pnsrouter boost )
|
add_dependencies( pnsrouter boost )
|
||||||
|
|
||||||
|
|
||||||
if ( KICAD_BUILD_STATIC OR KICAD_BUILD_DYNAMIC )
|
if( KICAD_BUILD_STATIC OR KICAD_BUILD_DYNAMIC )
|
||||||
add_dependencies( pcbnew lib-dependencies )
|
add_dependencies( pcbnew lib-dependencies )
|
||||||
add_dependencies( eeschema lib-dependencies )
|
add_dependencies( eeschema lib-dependencies )
|
||||||
add_dependencies( cvpcb lib-dependencies )
|
add_dependencies( cvpcb lib-dependencies )
|
||||||
|
@ -695,7 +695,7 @@ if ( KICAD_BUILD_STATIC OR KICAD_BUILD_DYNAMIC )
|
||||||
add_dependencies( pnsrouter lib-dependencies )
|
add_dependencies( pnsrouter lib-dependencies )
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
if ( KICAD_BUILD_DYNAMIC )
|
if( KICAD_BUILD_DYNAMIC )
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
#############
|
#############
|
||||||
|
|
|
@ -615,6 +615,33 @@ Create additional DRC tests for improved error checking.
|
||||||
**Progress:**
|
**Progress:**
|
||||||
- Planning
|
- Planning
|
||||||
|
|
||||||
|
## Segment End Point Snapping. ## {#segment_snapping}
|
||||||
|
**Goal:**
|
||||||
|
|
||||||
|
It is not uncommon for board edge segment end points to inadvertently not
|
||||||
|
be closed causing issues for the 3D viewer and exporting to different file
|
||||||
|
formats due the board outline not being a fully enclosed polygon. This
|
||||||
|
feature would add segment end snapping support to allow the board outline
|
||||||
|
to be fully enclosed. This feature would only need to be supported by the
|
||||||
|
GAL rendering.
|
||||||
|
|
||||||
|
**Tasks**
|
||||||
|
- Mark board edge segment ends with a drag indicator to make it visible to the
|
||||||
|
user that the segment end does not have an endpoint with any other board edge
|
||||||
|
segment.
|
||||||
|
- Allow the user to smap the unconnected segment end to the nearest segment end
|
||||||
|
point.
|
||||||
|
- Automatically connect unconnected segments with and additional segment when
|
||||||
|
opening the 3D viewer or exporting the board to another format. Warn the
|
||||||
|
user that an addition segment has be added and should be verified.
|
||||||
|
|
||||||
|
**Dependencies:**
|
||||||
|
- None
|
||||||
|
|
||||||
|
**Progress:**
|
||||||
|
- Initial discussion.
|
||||||
|
|
||||||
|
|
||||||
## Gerber File Attributes ## {#gerber_attributes}
|
## Gerber File Attributes ## {#gerber_attributes}
|
||||||
**Goal:**
|
**Goal:**
|
||||||
|
|
||||||
|
|
28
Doxyfile
28
Doxyfile
|
@ -324,22 +324,6 @@ INLINE_SIMPLE_STRUCTS = NO
|
||||||
|
|
||||||
TYPEDEF_HIDES_STRUCT = NO
|
TYPEDEF_HIDES_STRUCT = NO
|
||||||
|
|
||||||
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
|
|
||||||
# determine which symbols to keep in memory and which to flush to disk.
|
|
||||||
# When the cache is full, less often used symbols will be written to disk.
|
|
||||||
# For small to medium size projects (<1000 input files) the default value is
|
|
||||||
# probably good enough. For larger projects a too small cache size can cause
|
|
||||||
# doxygen to be busy swapping symbols to and from disk most of the time
|
|
||||||
# causing a significant performance penalty.
|
|
||||||
# If the system has enough physical memory increasing the cache will improve the
|
|
||||||
# performance by keeping more symbols in memory. Note that the value works on
|
|
||||||
# a logarithmic scale so increasing the size by one will roughly double the
|
|
||||||
# memory usage. The cache size is given by this formula:
|
|
||||||
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
|
|
||||||
# corresponding to a cache size of 2^16 = 65536 symbols.
|
|
||||||
|
|
||||||
SYMBOL_CACHE_SIZE = 4
|
|
||||||
|
|
||||||
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
|
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
|
||||||
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
|
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
|
||||||
# their name and scope. Since this can be an expensive process and often the
|
# their name and scope. Since this can be an expensive process and often the
|
||||||
|
@ -1423,18 +1407,6 @@ GENERATE_XML = NO
|
||||||
|
|
||||||
XML_OUTPUT = xml
|
XML_OUTPUT = xml
|
||||||
|
|
||||||
# The XML_SCHEMA tag can be used to specify an XML schema,
|
|
||||||
# which can be used by a validating XML parser to check the
|
|
||||||
# syntax of the XML files.
|
|
||||||
|
|
||||||
XML_SCHEMA =
|
|
||||||
|
|
||||||
# The XML_DTD tag can be used to specify an XML DTD,
|
|
||||||
# which can be used by a validating XML parser to check the
|
|
||||||
# syntax of the XML files.
|
|
||||||
|
|
||||||
XML_DTD =
|
|
||||||
|
|
||||||
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
|
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
|
||||||
# dump the program listings (including syntax highlighting
|
# dump the program listings (including syntax highlighting
|
||||||
# and cross-referencing information) to the XML output. Note that
|
# and cross-referencing information) to the XML output. Note that
|
||||||
|
|
|
@ -24,7 +24,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file drawframe.cpp
|
* @file draw_frame.cpp
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include <fctsys.h>
|
#include <fctsys.h>
|
||||||
|
|
|
@ -24,7 +24,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file drawpanel.cpp
|
* @file draw_panel.cpp
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include <fctsys.h>
|
#include <fctsys.h>
|
||||||
|
|
|
@ -23,7 +23,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file printout_controller.cpp
|
* @file printout_control.cpp
|
||||||
* @brief Board print handler implementation file.
|
* @brief Board print handler implementation file.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -268,8 +268,6 @@ public:
|
||||||
* Function LoadProjectFile
|
* Function LoadProjectFile
|
||||||
* loads the KiCad project file (*.pro) settings specific to Eeschema.
|
* loads the KiCad project file (*.pro) settings specific to Eeschema.
|
||||||
*
|
*
|
||||||
* @param aFileName The project file name to load.
|
|
||||||
* @param aForceReread Force the project file to be reread if true.
|
|
||||||
* @return True if the project file was loaded correctly.
|
* @return True if the project file was loaded correctly.
|
||||||
*/
|
*/
|
||||||
bool LoadProjectFile();
|
bool LoadProjectFile();
|
||||||
|
@ -643,18 +641,6 @@ public:
|
||||||
*/
|
*/
|
||||||
void OnSaveProject( wxCommandEvent& aEvent );
|
void OnSaveProject( wxCommandEvent& aEvent );
|
||||||
|
|
||||||
/**
|
|
||||||
* Function OpenProjectFiles
|
|
||||||
* loads an entire project into the schematic editor.
|
|
||||||
*
|
|
||||||
* This function loads schematic root file and it's subhierarchies, the project
|
|
||||||
* configuration, and the component libraries which are not already loaded.
|
|
||||||
*
|
|
||||||
* @param aFileSet is a list of one file, the top level schematic.
|
|
||||||
*
|
|
||||||
* @return bool - true if the project loaded properly, else false.
|
|
||||||
*/
|
|
||||||
//bool LoadOneEEProject( const wxString& aFileName, bool aIsNew );
|
|
||||||
bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl = 0 ); // virtual from KIWAY_PLAYER
|
bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl = 0 ); // virtual from KIWAY_PLAYER
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -674,7 +660,7 @@ public:
|
||||||
* @param aFullFileName A reference to a wxString object containing the absolute path
|
* @param aFullFileName A reference to a wxString object containing the absolute path
|
||||||
* and file name to load.
|
* and file name to load.
|
||||||
* @param append True if loaded file is being appended to the currently open file instead
|
* @param append True if loaded file is being appended to the currently open file instead
|
||||||
* of replacing it.
|
* of replacing it.
|
||||||
* @return True if \a aFullFileName has been loaded (at least partially.)
|
* @return True if \a aFullFileName has been loaded (at least partially.)
|
||||||
*/
|
*/
|
||||||
bool LoadOneEEFile( SCH_SCREEN* aScreen, const wxString& aFullFileName, bool append = false );
|
bool LoadOneEEFile( SCH_SCREEN* aScreen, const wxString& aFullFileName, bool append = false );
|
||||||
|
@ -705,8 +691,8 @@ public:
|
||||||
* @param aForceVisibilityState = Set to true to change the footprint field visibility
|
* @param aForceVisibilityState = Set to true to change the footprint field visibility
|
||||||
* state to \a aVisibilityState. False retains the
|
* state to \a aVisibilityState. False retains the
|
||||||
* current footprint field visibility state.
|
* current footprint field visibility state.
|
||||||
* @param aVisiblityState True to show the footprint field or false to hide the footprint
|
* @param aVisibilityState True to show the footprint field or false to hide the footprint
|
||||||
* field if \a aForceVisibilityState is true.
|
* field if \a aForceVisibilityState is true.
|
||||||
* @return bool = true if success.
|
* @return bool = true if success.
|
||||||
*/
|
*/
|
||||||
bool ProcessCmpToFootprintLinkFile( const wxString& aFullFilename,
|
bool ProcessCmpToFootprintLinkFile( const wxString& aFullFilename,
|
||||||
|
@ -1004,16 +990,20 @@ private:
|
||||||
* if libname != "", search in lib "libname"
|
* if libname != "", search in lib "libname"
|
||||||
* else search in all loaded libs
|
* else search in all loaded libs
|
||||||
*
|
*
|
||||||
|
* @param aDC is the device context to draw upon.
|
||||||
|
* @param aLibName is the library name to load the component from.
|
||||||
* @param aHistoryList list remembering recently used component names.
|
* @param aHistoryList list remembering recently used component names.
|
||||||
* @param aHistoryLastUnit remembering last unit in last component.
|
* @param aHistoryLastUnit remembering last unit in last component.
|
||||||
|
* @param aUseLibBrowser is the flag to determine if the library browser should be launched.
|
||||||
|
* @return a pointer the SCH_COMPONENT object selected or NULL if no component was selected.
|
||||||
* (TODO(hzeller): This really should be a class doing history, but didn't
|
* (TODO(hzeller): This really should be a class doing history, but didn't
|
||||||
* want to change too much while other refactoring is going on)
|
* want to change too much while other refactoring is going on)
|
||||||
*/
|
*/
|
||||||
SCH_COMPONENT* Load_Component( wxDC* DC,
|
SCH_COMPONENT* Load_Component( wxDC* aDC,
|
||||||
const wxString& libname,
|
const wxString& aLibName,
|
||||||
wxArrayString& aHistoryList,
|
wxArrayString& aHistoryList,
|
||||||
int& aHistoryLastUnit,
|
int& aHistoryLastUnit,
|
||||||
bool UseLibBrowser );
|
bool aUseLibBrowser );
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Function EditComponent
|
* Function EditComponent
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/**
|
/**
|
||||||
* @file autoplac.cpp
|
* @file auto_place_footprints.cpp
|
||||||
* @brief Functions to automatically place Footprints on a board.
|
* @brief Functions to automatically place Footprints on a board.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -26,7 +26,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file automove.cpp
|
* @file move_and_route_event_functions.cpp
|
||||||
* @brief Routines for automatic displacement and rotation of modules.
|
* @brief Routines for automatic displacement and rotation of modules.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/**
|
/**
|
||||||
* @file zones_non_copper_type_functions.cpp
|
* @file dialog_non_copper_zones_properties.cpp
|
||||||
*/
|
*/
|
||||||
/*
|
/*
|
||||||
* This program source code file is part of KiCad, a free EDA CAD application.
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
||||||
|
|
Loading…
Reference in New Issue