Doxygen documentation
This commit is contained in:
@@ -51,7 +51,7 @@ PROJECT_BRIEF =
|
||||
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
|
||||
# the logo to the output directory.
|
||||
|
||||
PROJECT_LOGO =
|
||||
PROJECT_LOGO = /home/mari/projects/cpp/gds-render/icon/gds-render.svg
|
||||
|
||||
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
|
||||
# into which the generated documentation will be written. If a relative path is
|
||||
|
0
doxygen/additional-pages.dox
Normal file
0
doxygen/additional-pages.dox
Normal file
47
doxygen/main-page.dox
Normal file
47
doxygen/main-page.dox
Normal file
@@ -0,0 +1,47 @@
|
||||
/**
|
||||
|
||||
@mainpage
|
||||
This programm converts GDS layout files to
|
||||
|
||||
- PDF Files using the @ref Cairo-Renderer
|
||||
- Latex code (TikZ) using the @ref LaTeX-Renderer
|
||||
|
||||
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
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
*/
|
6
doxygen/widgets.dox
Normal file
6
doxygen/widgets.dox
Normal file
@@ -0,0 +1,6 @@
|
||||
/* This file only contains help information for doxygen */
|
||||
|
||||
/**
|
||||
* @defgroup Widgets Custom GTK Widgets
|
||||
*
|
||||
*/
|
Reference in New Issue
Block a user