doxygen documentation, add image of GUI
This commit is contained in:
parent
f204d4c2e8
commit
13676deb34
@ -927,7 +927,7 @@ EXAMPLE_RECURSIVE = NO
|
||||
# that contain images that are to be included in the documentation (see the
|
||||
# \image command).
|
||||
|
||||
IMAGE_PATH =
|
||||
IMAGE_PATH = images
|
||||
|
||||
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
||||
# invoke to filter for each input file. Doxygen will invoke the filter program
|
||||
|
BIN
doxygen/images/gui.pdf
Normal file
BIN
doxygen/images/gui.pdf
Normal file
Binary file not shown.
2036
doxygen/images/gui.svg
Normal file
2036
doxygen/images/gui.svg
Normal file
File diff suppressed because it is too large
Load Diff
After Width: | Height: | Size: 114 KiB |
@ -10,27 +10,6 @@ See the @subpage usage page for details
|
||||
|
||||
|
||||
|
||||
@page usage Usage
|
||||
@section cmd Command Line Interface
|
||||
To use the application on the command line check 'gds-render --help'.
|
||||
|
||||
Application options:
|
||||
- -t, --tikz Output TikZ code
|
||||
- -p, --pdf Output PDF document
|
||||
- -s, --scale=<SCALE> Divide output coordinates by <SCALE>
|
||||
- -o, --tex-output=PATH Optional path for TeX file
|
||||
- -O, --pdf-output=PATH Optional path for PDF file
|
||||
- -m, --mapping=PATH Path for Layer Mapping File
|
||||
- -c, --cell=NAME Cell to render
|
||||
- -a, --tex-standalone Configure TeX Code standalone
|
||||
- -l, --tex-layers configure TeX code to create PDF Layers (OCG)
|
||||
|
||||
@section gui Graphical User Interface
|
||||
|
||||
The graphical user interface (GUI) can be used to Open GDS Files, configure the layer rendering (colors, order, transparency etc.) and convert cells.
|
||||
|
||||
It is possible to export the layer configurations so theycan be used later on. Even in the @ref cmd
|
||||
|
||||
|
||||
|
||||
|
||||
|
25
doxygen/usage.dox
Normal file
25
doxygen/usage.dox
Normal file
@ -0,0 +1,25 @@
|
||||
/**
|
||||
@page usage Usage
|
||||
@section cmd Command Line Interface
|
||||
To use the application on the command line check 'gds-render --help'.
|
||||
|
||||
Application options:
|
||||
- -t, --tikz Output TikZ code
|
||||
- -p, --pdf Output PDF document
|
||||
- -s, --scale=<SCALE> Divide output coordinates by <SCALE>
|
||||
- -o, --tex-output=PATH Optional path for TeX file
|
||||
- -O, --pdf-output=PATH Optional path for PDF file
|
||||
- -m, --mapping=PATH Path for Layer Mapping File (see @ref lmf-spec)
|
||||
- -c, --cell=NAME Cell to render
|
||||
- -a, --tex-standalone Configure TeX Code standalone
|
||||
- -l, --tex-layers configure TeX code to create PDF Layers (OCG)
|
||||
|
||||
@section gui Graphical User Interface
|
||||
|
||||
The graphical user interface (GUI) can be used to open GDS Files, configure the layer rendering (colors, order, transparency etc.), and convert cells.
|
||||
|
||||
It is possible to export the layer configurations so theycan be used later on. Even in the @ref cmd
|
||||
|
||||
@image html gui.svg
|
||||
|
||||
*/
|
Loading…
Reference in New Issue
Block a user