root/juggler/branches/2.2/modules/gadgeteer/doc/Gadgeteer_latex.doxy

Revision 8035, 4.6 kB (checked in by patrickh, 7 years ago)

After much badgering from Allen, the Doxygen HTML tree view is being
turned on. It's easy enough to avoid using it, and the website will
offer the alternative JavaScript?-free view.

Something about the tree view breaks the LaTeX generation, however, so
the LaTeX-specific files now disable tree view creation. There is
probably another explanation for this, but it can be tracked down later.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1 # Include default values
2 @INCLUDE = Gadgeteer.doxy
3
4 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
5 # include brief member descriptions after the members that are listed in
6 # the file and class documentation (similar to JavaDoc).
7 # Set to NO to disable this.
8
9 BRIEF_MEMBER_DESC      = NO
10
11 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
12 # path before files name in the file list and in the header files. If set
13 # to NO the shortest path that makes the file name unique will be used.
14
15 FULL_PATH_NAMES        = NO
16
17 # The INTERNAL_DOCS tag determines if documentation
18 # that is typed after a \internal command is included. If the tag is set
19 # to NO (the default) then the documentation will be excluded.
20 # Set it to YES to include the internal documentation.
21
22 INTERNAL_DOCS          = NO
23
24 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
25 # be generated. Documented entities will be cross-referenced with these
26 # sources.
27
28 SOURCE_BROWSER         = NO
29
30 # Setting the INLINE_SOURCES tag to YES will include the body
31 # of functions and classes directly in the documentation.
32
33 INLINE_SOURCES         = NO
34
35 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
36 # will generate a verbatim copy of the header file for each class for
37 # which an include is specified. Set to NO to disable this.
38
39 VERBATIM_HEADERS       = NO
40
41 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
42 # will put list of the files that are included by a file in the documentation
43 # of that file.
44
45 SHOW_INCLUDE_FILES     = NO
46
47 # The GENERATE_TODOLIST tag can be used to enable (YES) or
48 # disable (NO) the todo list. This list is created by putting \todo
49 # commands in the documentation.
50
51 GENERATE_TODOLIST      = YES
52
53 # If the GENERATE_TREEVIEW tag is set to YES, a side pannel will be
54 # generated containing a tree-like index structure (just like the one that
55 # is generated for HTML Help). For this to work a browser that supports
56 # JavaScript and frames is required (for instance Netscape 4.0+
57 # or Internet explorer 4.0+).
58
59 GENERATE_TREEVIEW      = NO
60
61 # We are only generating LaTeX with this file.
62 GENERATE_HTML          = NO
63 GENERATE_MAN           = NO
64 GENERATE_RTF           = NO
65 GENERATE_XML           = NO
66
67 #---------------------------------------------------------------------------
68 # configuration options related to the LaTeX output
69 #---------------------------------------------------------------------------
70
71 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
72 # generate Latex output.
73
74 GENERATE_LATEX         = YES
75
76 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
77 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
78 # put in front of it. If left blank `latex' will be used as the default path.
79
80 LATEX_OUTPUT           = latex
81
82 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
83 # LaTeX documents. This may be useful for small projects and may help to
84 # save some trees in general.
85
86 COMPACT_LATEX          = NO
87
88 # The PAPER_TYPE tag can be used to set the paper type that is used
89 # by the printer. Possible values are: a4, a4wide, letter, legal and
90 # executive. If left blank a4wide will be used.
91
92 PAPER_TYPE             = letter
93
94 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
95 # packages that should be included in the LaTeX output.
96
97 EXTRA_PACKAGES         =
98
99 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
100 # the generated latex document. The header should contain everything until
101 # the first chapter. If it is left blank doxygen will generate a
102 # standard header. Notice: only use this tag if you know what you are doing!
103
104 LATEX_HEADER           =
105
106 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
107 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
108 # contain links (just like the HTML output) instead of page references
109 # This makes the output suitable for online browsing using a pdf viewer.
110
111 PDF_HYPERLINKS         = NO
112
113 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
114 # plain latex in the generated Makefile. Set this option to YES to get a
115 # higher quality PDF documentation.
116
117 USE_PDFLATEX           = YES
118
119 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
120 # command to the generated LaTeX files. This will instruct LaTeX to keep
121 # running if errors occur, instead of asking the user for help.
122 # This option is also used when generating formulas in HTML.
123
124 LATEX_BATCHMODE        = NO
Note: See TracBrowser for help on using the browser.