Skip to content

Latest commit

 

History

History
134 lines (120 loc) · 4.92 KB

File metadata and controls

134 lines (120 loc) · 4.92 KB

User Manual start-doc options

These options define the order in which documentation in the source files is inserted into the User Manual.

General

ID Description Proposed ID
1 General Options
2 General GUI Options
3 Colors
4 Layer Names
5 Paths
5 Sizes --> 6
6 Commands --> 7
7 DRC Options --> 8

Graphical User Interfaces

ID Description File
21 GTK+ GUI Options src/hid/gtk/gui-top-window.c
22 lesstif GUI Options src/hid/lesstif/main.c
23 lessGTK+ GUI Options src/hid/lessgtk/gui-top-window.c

Exporters

ID Description File
80 BOM Creation src/hid/bom/bom.c
81 XML Options src/hid/xml/xml.c (Work In Progress)
82 BOM MarkDown format src/hid/bom_md/bom_md.c
83 verilog-AMS export src/hid/vams/vams.c (not started)
84 PNP (XY-placement) Options src/pnp/pnp.c (not started)
85 G-code Options src/hid/gcode/gcode.c
86 IDF-3.0 Options src/idf/idf.c (not started)
87
88
89
90 Gerber Export src/hid/gerber/gerber.c
91 Postscript Export src/hid/ps/ps.c
92 Encapsulated Postscript Export src/hid/ps/eps.c
93 PNG Options src/hid/png/png.c
94 Nelma Options src/hid/nelma/nelma.c
95 IPC-D-356 Netlist Export src/hid/ipcd356/ipcd356.c
96 Gsvit Options src/hid/gsvit/gsvit.c
97 DXF Export src/hid/dxf/dxf.c (Work In Progress)
98 lpr Printing Options src/hid/lpr/lpr.c
99 pcbshopper.com RFQ src/hid/shopper/shopper.c (Work In Progress)

Actions

File Description
src/hid/common/actions.c 00macros
src/hid/common/actions.c PCBChanged
src/hid/common/actions.c RouteStylesChanged
src/hid/common/actions.c NetlistChanged
src/hid/common/actions.c LayersChanged
src/hid/common/actions.c LibraryChanged
src/hid/gtk/gtkhid-main.c Zoom
src/hid/gtk/gtkhid-main.c About
src/hid/gtk/gtkhid-main.c GetXY
src/hid/gtk/gtkhid-main.c Save
src/hid/gtk/gtkhid-main.c SwapSides
src/hid/gtk/gtkhid-main.c Print
src/hid/gtk/gtkhid-main.c PrintCalibrate
src/hid/gtk/gtkhid-main.c Center
src/hid/gtk/gtkhid-main.c Cursor
src/hid/gtk/gtkhid-main.c DoWindows
src/hid/gtk/gtkhid-main.c SetUnits
src/hid/gtk/gtkhid-main.c Pan
src/hid/gtk/gtkhid-main.c Popup
src/hid/gtk/gtkhid-main.c ImportGUI
src/hid/gtk/gui-top-window.c ToggleView
src/hid/gtk/gui-top-window.c SelectLayer
src/hid/gtk/gui-top-window.c AdjustStyle
src/hid/gtk/gui-top-window.c EditLayerGroups
src/hid/lessgtk/gtkhid-main.c Zoom
src/hid/lessgtk/gtkhid-main.c About
src/hid/lessgtk/gtkhid-main.c GetXY
src/hid/lessgtk/gtkhid-main.c Save
src/hid/lessgtk/gtkhid-main.c SwapSides
src/hid/lessgtk/gtkhid-main.c Print
src/hid/lessgtk/gtkhid-main.c PrintCalibrate
src/hid/lessgtk/gtkhid-main.c Center
src/hid/lessgtk/gtkhid-main.c Cursor
src/hid/lessgtk/gtkhid-main.c DoWindows
src/hid/lessgtk/gtkhid-main.c SetUnits
src/hid/lessgtk/gtkhid-main.c Pan
src/hid/lessgtk/gtkhid-main.c Popup
src/hid/lessgtk/gtkhid-main.c ImportGUI
src/hid/lessgtk/gui-top-window.c ToggleView
src/hid/lessgtk/gui-top-window.c SelectLayer
src/hid/lessgtk/gui-top-window.c AdjustStyle
src/hid/lessgtk/gui-top-window.c EditLayerGroups
src/hid/lesstif/dialogs.c Load
src/hid/lesstif/dialogs.c LoadVendor
src/hid/lesstif/dialogs.c Save
src/hid/lesstif/dialogs.c PromptFor
src/hid/lesstif/dialogs.c DoWindows
src/hid/lesstif/dialogs.c About
src/hid/lesstif/dialogs.c Print
src/hid/lesstif/dialogs.c PrintCalibrate
src/hid/lesstif/dialogs.c Export
src/hid/lesstif/dialogs.c AdjustSizes
src/hid/lesstif/dialogs.c EditLayerGroups
src/hid/lesstif/dialogs.c ImportGUI
src/hid/lesstif/library.c LibraryShow
src/hid/lesstif/main.c SetUnits
src/hid/lesstif/main.c Zoom
src/hid/lesstif/main.c SwapSides
src/hid/lesstif/main.c Command
src/hid/lesstif/main.c Benchmark
src/hid/lesstif/main.c Cursor
src/hid/lesstif/menu.c GetXY
src/hid/lesstif/menu.c Debug
src/hid/lesstif/menu.c DebugXY
src/hid/lesstif/menu.c Return
src/hid/lesstif/menu.c DumpKeys
src/hid/lesstif/menu.c SelectLayer
src/hid/lesstif/menu.c ToggleView
src/hid/lesstif/netlist.c NetlistShow
src/hid/lesstif/styles.c AdjustStyle

corrections / todo

The GUI action Scroll is not documented in the user manual

src/hid/gtk/gtkhid-main.c:/* % start-doc actions Scroll --> remove white space

src/hid/lessgtk/gtkhid-main.c:/* % start-doc actions Scroll --> remove white space

note: removing the white space breaks building the user manual.