Commit 99f30c9d authored by Wayne Stambaugh's avatar Wayne Stambaugh
Browse files

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
parent 94f8c2a2
Loading
Loading
Loading
Loading
+27 −0
Original line number Original line Diff line number Diff line
@@ -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:**


+0 −28
Original line number Original line Diff line number Diff line
@@ -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
+1 −1
Original line number Original line Diff line number Diff line
@@ -24,7 +24,7 @@
 */
 */


/**
/**
 * @file drawframe.cpp
 * @file draw_frame.cpp
 */
 */


#include <fctsys.h>
#include <fctsys.h>
+1 −1
Original line number Original line Diff line number Diff line
@@ -24,7 +24,7 @@
 */
 */


/**
/**
 * @file drawpanel.cpp
 * @file draw_panel.cpp
 */
 */


#include <fctsys.h>
#include <fctsys.h>
+1 −1
Original line number Original line Diff line number Diff line
@@ -23,7 +23,7 @@
 */
 */


/**
/**
 * @file printout_controller.cpp
 * @file printout_control.cpp
 * @brief Board print handler implementation file.
 * @brief Board print handler implementation file.
 */
 */


Loading