diff options
author | Christian Grothoff <christian@grothoff.org> | 2013-09-07 13:50:57 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2013-09-07 13:50:57 +0000 |
commit | 39bf7a17bf2e73b50a8a700cf3344e5e6956f820 (patch) | |
tree | 26d1abf337bb83c9a5a739f555a4e96b05568bf5 | |
parent | fd84044d142680c4907af70e7dcc031fb816219a (diff) | |
download | gnunet-gtk-39bf7a17bf2e73b50a8a700cf3344e5e6956f820.tar.gz gnunet-gtk-39bf7a17bf2e73b50a8a700cf3344e5e6956f820.zip |
add doxygen
-rw-r--r-- | configure.ac | 1 | ||||
-rw-r--r-- | contrib/gnunet_identity_gtk_about_window.glade | 2 | ||||
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/doxygen/Makefile.am | 14 | ||||
-rw-r--r-- | doc/doxygen/gnunet.doxy | 302 |
5 files changed, 320 insertions, 1 deletions
diff --git a/configure.ac b/configure.ac index 7ef573e3..8119a282 100644 --- a/configure.ac +++ b/configure.ac | |||
@@ -506,6 +506,7 @@ AC_OUTPUT([ | |||
506 | Makefile | 506 | Makefile |
507 | contrib/Makefile | 507 | contrib/Makefile |
508 | doc/Makefile | 508 | doc/Makefile |
509 | doc/doxygen/Makefile | ||
509 | src/Makefile | 510 | src/Makefile |
510 | src/include/Makefile | 511 | src/include/Makefile |
511 | src/lib/Makefile | 512 | src/lib/Makefile |
diff --git a/contrib/gnunet_identity_gtk_about_window.glade b/contrib/gnunet_identity_gtk_about_window.glade index a75a926a..097e8709 100644 --- a/contrib/gnunet_identity_gtk_about_window.glade +++ b/contrib/gnunet_identity_gtk_about_window.glade | |||
@@ -91,7 +91,7 @@ Daniel Nylander <po@danielnylander.se></property> | |||
91 | <object class="GtkLabel" id="about_name_version_label"> | 91 | <object class="GtkLabel" id="about_name_version_label"> |
92 | <property name="visible">True</property> | 92 | <property name="visible">True</property> |
93 | <property name="can_focus">False</property> | 93 | <property name="can_focus">False</property> |
94 | <property name="label">GNUnet-Peerinfo-GTK 0.9.5</property> | 94 | <property name="label">GNUnet-Peerinfo-GTK 0.9.3</property> |
95 | <attributes> | 95 | <attributes> |
96 | <attribute name="weight" value="bold"/> | 96 | <attribute name="weight" value="bold"/> |
97 | <attribute name="size" value="200"/> | 97 | <attribute name="size" value="200"/> |
diff --git a/doc/Makefile.am b/doc/Makefile.am index 7d23c131..23535d27 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am | |||
@@ -1,3 +1,5 @@ | |||
1 | SUBDIRS = . doxygen | ||
2 | |||
1 | man_MANS = \ | 3 | man_MANS = \ |
2 | gnunet-fs-gtk.1 \ | 4 | gnunet-fs-gtk.1 \ |
3 | gnunet-setup.1 \ | 5 | gnunet-setup.1 \ |
diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am new file mode 100644 index 00000000..80fe87ec --- /dev/null +++ b/doc/doxygen/Makefile.am | |||
@@ -0,0 +1,14 @@ | |||
1 | all: | ||
2 | @echo -e \ | ||
3 | "Generate documentation:\n" \ | ||
4 | "\tmake full - full documentation with dependency graphs (slow)\n" \ | ||
5 | "\tmake fast - fast mode without dependency graphs" | ||
6 | |||
7 | full: gnunet.doxy | ||
8 | doxygen $< | ||
9 | |||
10 | fast: gnunet.doxy | ||
11 | sed 's/\(HAVE_DOT.*=\).*/\1 NO/' $< | doxygen - | ||
12 | |||
13 | clean: | ||
14 | rm -rf html | ||
diff --git a/doc/doxygen/gnunet.doxy b/doc/doxygen/gnunet.doxy new file mode 100644 index 00000000..b092d69b --- /dev/null +++ b/doc/doxygen/gnunet.doxy | |||
@@ -0,0 +1,302 @@ | |||
1 | # Doxyfile 1.5.6 | ||
2 | |||
3 | #--------------------------------------------------------------------------- | ||
4 | # Project related configuration options | ||
5 | #--------------------------------------------------------------------------- | ||
6 | DOXYFILE_ENCODING = UTF-8 | ||
7 | PROJECT_NAME = GNUnet-gtk | ||
8 | PROJECT_NUMBER = 0.9.x | ||
9 | OUTPUT_DIRECTORY = . | ||
10 | CREATE_SUBDIRS = YES | ||
11 | OUTPUT_LANGUAGE = English | ||
12 | BRIEF_MEMBER_DESC = YES | ||
13 | REPEAT_BRIEF = YES | ||
14 | ABBREVIATE_BRIEF = "The $name class" \ | ||
15 | "The $name widget" \ | ||
16 | "The $name file" \ | ||
17 | is \ | ||
18 | provides \ | ||
19 | specifies \ | ||
20 | contains \ | ||
21 | represents \ | ||
22 | a \ | ||
23 | an \ | ||
24 | the | ||
25 | ALWAYS_DETAILED_SEC = NO | ||
26 | INLINE_INHERITED_MEMB = NO | ||
27 | FULL_PATH_NAMES = YES | ||
28 | STRIP_FROM_PATH = ../.. | ||
29 | STRIP_FROM_INC_PATH = ../../src/include \ | ||
30 | src/include | ||
31 | SHORT_NAMES = NO | ||
32 | JAVADOC_AUTOBRIEF = YES | ||
33 | QT_AUTOBRIEF = NO | ||
34 | MULTILINE_CPP_IS_BRIEF = NO | ||
35 | INHERIT_DOCS = YES | ||
36 | SEPARATE_MEMBER_PAGES = NO | ||
37 | TAB_SIZE = 8 | ||
38 | ALIASES = | ||
39 | OPTIMIZE_OUTPUT_FOR_C = YES | ||
40 | OPTIMIZE_OUTPUT_JAVA = NO | ||
41 | OPTIMIZE_FOR_FORTRAN = NO | ||
42 | OPTIMIZE_OUTPUT_VHDL = NO | ||
43 | BUILTIN_STL_SUPPORT = NO | ||
44 | CPP_CLI_SUPPORT = NO | ||
45 | SIP_SUPPORT = NO | ||
46 | IDL_PROPERTY_SUPPORT = YES | ||
47 | DISTRIBUTE_GROUP_DOC = NO | ||
48 | SUBGROUPING = YES | ||
49 | TYPEDEF_HIDES_STRUCT = NO | ||
50 | #--------------------------------------------------------------------------- | ||
51 | # Build related configuration options | ||
52 | #--------------------------------------------------------------------------- | ||
53 | EXTRACT_ALL = YES | ||
54 | EXTRACT_PRIVATE = YES | ||
55 | EXTRACT_STATIC = YES | ||
56 | EXTRACT_LOCAL_CLASSES = YES | ||
57 | EXTRACT_LOCAL_METHODS = YES | ||
58 | EXTRACT_ANON_NSPACES = YES | ||
59 | HIDE_UNDOC_MEMBERS = NO | ||
60 | HIDE_UNDOC_CLASSES = NO | ||
61 | HIDE_FRIEND_COMPOUNDS = NO | ||
62 | HIDE_IN_BODY_DOCS = NO | ||
63 | INTERNAL_DOCS = YES | ||
64 | CASE_SENSE_NAMES = NO | ||
65 | HIDE_SCOPE_NAMES = NO | ||
66 | SHOW_INCLUDE_FILES = YES | ||
67 | INLINE_INFO = YES | ||
68 | SORT_MEMBER_DOCS = NO | ||
69 | SORT_BRIEF_DOCS = NO | ||
70 | SORT_GROUP_NAMES = NO | ||
71 | SORT_BY_SCOPE_NAME = NO | ||
72 | GENERATE_TODOLIST = YES | ||
73 | GENERATE_TESTLIST = YES | ||
74 | GENERATE_BUGLIST = YES | ||
75 | GENERATE_DEPRECATEDLIST= YES | ||
76 | ENABLED_SECTIONS = | ||
77 | MAX_INITIALIZER_LINES = 30 | ||
78 | SHOW_USED_FILES = YES | ||
79 | SHOW_FILES = YES | ||
80 | SHOW_NAMESPACES = YES | ||
81 | FILE_VERSION_FILTER = | ||
82 | #--------------------------------------------------------------------------- | ||
83 | # configuration options related to warning and progress messages | ||
84 | #--------------------------------------------------------------------------- | ||
85 | QUIET = YES | ||
86 | WARNINGS = YES | ||
87 | WARN_IF_UNDOCUMENTED = YES | ||
88 | WARN_IF_DOC_ERROR = YES | ||
89 | WARN_NO_PARAMDOC = YES | ||
90 | WARN_FORMAT = "$file:$line: $text" | ||
91 | WARN_LOGFILE = | ||
92 | #--------------------------------------------------------------------------- | ||
93 | # configuration options related to the input files | ||
94 | #--------------------------------------------------------------------------- | ||
95 | INPUT = ../.. | ||
96 | INPUT_ENCODING = UTF-8 | ||
97 | FILE_PATTERNS = *.c \ | ||
98 | *.cc \ | ||
99 | *.cxx \ | ||
100 | *.cpp \ | ||
101 | *.c++ \ | ||
102 | *.d \ | ||
103 | *.java \ | ||
104 | *.ii \ | ||
105 | *.ixx \ | ||
106 | *.ipp \ | ||
107 | *.i++ \ | ||
108 | *.inl \ | ||
109 | *.h \ | ||
110 | *.hh \ | ||
111 | *.hxx \ | ||
112 | *.hpp \ | ||
113 | *.h++ \ | ||
114 | *.idl \ | ||
115 | *.odl \ | ||
116 | *.cs \ | ||
117 | *.php \ | ||
118 | *.php3 \ | ||
119 | *.inc \ | ||
120 | *.m \ | ||
121 | *.mm \ | ||
122 | *.dox \ | ||
123 | *.py \ | ||
124 | *.f90 \ | ||
125 | *.f \ | ||
126 | *.vhd \ | ||
127 | *.vhdl \ | ||
128 | *.C \ | ||
129 | *.CC \ | ||
130 | *.C++ \ | ||
131 | *.II \ | ||
132 | *.I++ \ | ||
133 | *.H \ | ||
134 | *.HH \ | ||
135 | *.H++ \ | ||
136 | *.CS \ | ||
137 | *.PHP \ | ||
138 | *.PHP3 \ | ||
139 | *.M \ | ||
140 | *.MM \ | ||
141 | *.PY \ | ||
142 | *.F90 \ | ||
143 | *.F \ | ||
144 | *.VHD \ | ||
145 | *.VHDL | ||
146 | RECURSIVE = YES | ||
147 | EXCLUDE = | ||
148 | EXCLUDE_SYMLINKS = NO | ||
149 | EXCLUDE_PATTERNS = */test_* */.svn/* */perf_* | ||
150 | EXCLUDE_SYMBOLS = | ||
151 | EXAMPLE_PATH = | ||
152 | EXAMPLE_PATTERNS = * | ||
153 | EXAMPLE_RECURSIVE = NO | ||
154 | IMAGE_PATH = | ||
155 | INPUT_FILTER = | ||
156 | FILTER_PATTERNS = | ||
157 | FILTER_SOURCE_FILES = NO | ||
158 | #--------------------------------------------------------------------------- | ||
159 | # configuration options related to source browsing | ||
160 | #--------------------------------------------------------------------------- | ||
161 | SOURCE_BROWSER = YES | ||
162 | INLINE_SOURCES = YES | ||
163 | STRIP_CODE_COMMENTS = YES | ||
164 | REFERENCED_BY_RELATION = YES | ||
165 | REFERENCES_RELATION = YES | ||
166 | REFERENCES_LINK_SOURCE = YES | ||
167 | USE_HTAGS = NO | ||
168 | VERBATIM_HEADERS = YES | ||
169 | #--------------------------------------------------------------------------- | ||
170 | # configuration options related to the alphabetical class index | ||
171 | #--------------------------------------------------------------------------- | ||
172 | ALPHABETICAL_INDEX = YES | ||
173 | COLS_IN_ALPHA_INDEX = 3 | ||
174 | IGNORE_PREFIX = GNUNET_ | ||
175 | #--------------------------------------------------------------------------- | ||
176 | # configuration options related to the HTML output | ||
177 | #--------------------------------------------------------------------------- | ||
178 | GENERATE_HTML = YES | ||
179 | HTML_OUTPUT = html | ||
180 | HTML_FILE_EXTENSION = .html | ||
181 | HTML_HEADER = | ||
182 | HTML_FOOTER = | ||
183 | HTML_STYLESHEET = | ||
184 | GENERATE_HTMLHELP = NO | ||
185 | GENERATE_DOCSET = NO | ||
186 | DOCSET_FEEDNAME = "GNUnet Source Documentation" | ||
187 | DOCSET_BUNDLE_ID = org.gnunet | ||
188 | HTML_DYNAMIC_SECTIONS = NO | ||
189 | CHM_FILE = | ||
190 | HHC_LOCATION = | ||
191 | GENERATE_CHI = NO | ||
192 | CHM_INDEX_ENCODING = | ||
193 | BINARY_TOC = NO | ||
194 | TOC_EXPAND = NO | ||
195 | DISABLE_INDEX = NO | ||
196 | ENUM_VALUES_PER_LINE = 4 | ||
197 | GENERATE_TREEVIEW = NONE | ||
198 | TREEVIEW_WIDTH = 250 | ||
199 | FORMULA_FONTSIZE = 10 | ||
200 | #--------------------------------------------------------------------------- | ||
201 | # configuration options related to the LaTeX output | ||
202 | #--------------------------------------------------------------------------- | ||
203 | GENERATE_LATEX = NO | ||
204 | LATEX_OUTPUT = latex | ||
205 | LATEX_CMD_NAME = latex | ||
206 | MAKEINDEX_CMD_NAME = makeindex | ||
207 | COMPACT_LATEX = YES | ||
208 | PAPER_TYPE = a4 | ||
209 | EXTRA_PACKAGES = | ||
210 | LATEX_HEADER = | ||
211 | PDF_HYPERLINKS = YES | ||
212 | USE_PDFLATEX = YES | ||
213 | LATEX_BATCHMODE = NO | ||
214 | LATEX_HIDE_INDICES = NO | ||
215 | #--------------------------------------------------------------------------- | ||
216 | # configuration options related to the RTF output | ||
217 | #--------------------------------------------------------------------------- | ||
218 | GENERATE_RTF = NO | ||
219 | RTF_OUTPUT = rtf | ||
220 | COMPACT_RTF = NO | ||
221 | RTF_HYPERLINKS = NO | ||
222 | RTF_STYLESHEET_FILE = | ||
223 | RTF_EXTENSIONS_FILE = | ||
224 | #--------------------------------------------------------------------------- | ||
225 | # configuration options related to the man page output | ||
226 | #--------------------------------------------------------------------------- | ||
227 | GENERATE_MAN = NO | ||
228 | MAN_OUTPUT = man | ||
229 | MAN_EXTENSION = .3 | ||
230 | MAN_LINKS = NO | ||
231 | #--------------------------------------------------------------------------- | ||
232 | # configuration options related to the XML output | ||
233 | #--------------------------------------------------------------------------- | ||
234 | GENERATE_XML = NO | ||
235 | XML_OUTPUT = xml | ||
236 | XML_SCHEMA = | ||
237 | XML_DTD = | ||
238 | XML_PROGRAMLISTING = YES | ||
239 | #--------------------------------------------------------------------------- | ||
240 | # configuration options for the AutoGen Definitions output | ||
241 | #--------------------------------------------------------------------------- | ||
242 | GENERATE_AUTOGEN_DEF = NO | ||
243 | #--------------------------------------------------------------------------- | ||
244 | # configuration options related to the Perl module output | ||
245 | #--------------------------------------------------------------------------- | ||
246 | GENERATE_PERLMOD = NO | ||
247 | PERLMOD_LATEX = NO | ||
248 | PERLMOD_PRETTY = YES | ||
249 | PERLMOD_MAKEVAR_PREFIX = | ||
250 | #--------------------------------------------------------------------------- | ||
251 | # Configuration options related to the preprocessor | ||
252 | #--------------------------------------------------------------------------- | ||
253 | ENABLE_PREPROCESSING = YES | ||
254 | MACRO_EXPANSION = YES | ||
255 | EXPAND_ONLY_PREDEF = NO | ||
256 | SEARCH_INCLUDES = YES | ||
257 | INCLUDE_PATH = | ||
258 | INCLUDE_FILE_PATTERNS = | ||
259 | PREDEFINED = GNUNET_UNUSED="" GNUNET_PACKED="" | ||
260 | EXPAND_AS_DEFINED = | ||
261 | SKIP_FUNCTION_MACROS = YES | ||
262 | #--------------------------------------------------------------------------- | ||
263 | # Configuration::additions related to external references | ||
264 | #--------------------------------------------------------------------------- | ||
265 | TAGFILES = | ||
266 | GENERATE_TAGFILE = | ||
267 | ALLEXTERNALS = NO | ||
268 | EXTERNAL_GROUPS = YES | ||
269 | PERL_PATH = /usr/bin/perl | ||
270 | #--------------------------------------------------------------------------- | ||
271 | # Configuration options related to the dot tool | ||
272 | #--------------------------------------------------------------------------- | ||
273 | CLASS_DIAGRAMS = YES | ||
274 | MSCGEN_PATH = | ||
275 | HIDE_UNDOC_RELATIONS = YES | ||
276 | HAVE_DOT = YES | ||
277 | DOT_FONTNAME = FreeSans | ||
278 | DOT_FONTPATH = | ||
279 | CLASS_GRAPH = YES | ||
280 | COLLABORATION_GRAPH = YES | ||
281 | GROUP_GRAPHS = YES | ||
282 | UML_LOOK = NO | ||
283 | TEMPLATE_RELATIONS = NO | ||
284 | INCLUDE_GRAPH = YES | ||
285 | INCLUDED_BY_GRAPH = YES | ||
286 | CALL_GRAPH = YES | ||
287 | CALLER_GRAPH = YES | ||
288 | GRAPHICAL_HIERARCHY = YES | ||
289 | DIRECTORY_GRAPH = YES | ||
290 | DOT_IMAGE_FORMAT = png | ||
291 | DOT_PATH = | ||
292 | DOTFILE_DIRS = | ||
293 | DOT_GRAPH_MAX_NODES = 500 | ||
294 | MAX_DOT_GRAPH_DEPTH = 1000 | ||
295 | DOT_TRANSPARENT = YES | ||
296 | DOT_MULTI_TARGETS = YES | ||
297 | GENERATE_LEGEND = YES | ||
298 | DOT_CLEANUP = YES | ||
299 | #--------------------------------------------------------------------------- | ||
300 | # Configuration::additions related to the search engine | ||
301 | #--------------------------------------------------------------------------- | ||
302 | SEARCHENGINE = YES | ||