Skip to content

Commit 6ece46b

Browse files
committed
- added doxygen files
1 parent b15e87f commit 6ece46b

File tree

3 files changed

+375
-1
lines changed

3 files changed

+375
-1
lines changed

doxygen/Doxyfile

Lines changed: 374 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,374 @@
1+
# Doxyfile 1.8.11
2+
3+
#---------------------------------------------------------------------------
4+
# Project related configuration options
5+
#---------------------------------------------------------------------------
6+
DOXYFILE_ENCODING = UTF-8
7+
PROJECT_NAME = "lib60870.NET"
8+
PROJECT_NUMBER = "2.2.0"
9+
PROJECT_BRIEF = "IEC 60870-5-101/104 Protocol Source Code Library for C#/.NET"
10+
PROJECT_LOGO = doxygen/mz-automation.ico
11+
OUTPUT_DIRECTORY = doxydoc.NET
12+
CREATE_SUBDIRS = NO
13+
ALLOW_UNICODE_NAMES = NO
14+
OUTPUT_LANGUAGE = English
15+
BRIEF_MEMBER_DESC = YES
16+
REPEAT_BRIEF = YES
17+
ABBREVIATE_BRIEF = "The $name class" \
18+
"The $name widget" \
19+
"The $name file" \
20+
is \
21+
provides \
22+
specifies \
23+
contains \
24+
represents \
25+
a \
26+
an \
27+
the
28+
ALWAYS_DETAILED_SEC = NO
29+
INLINE_INHERITED_MEMB = NO
30+
FULL_PATH_NAMES = YES
31+
STRIP_FROM_PATH =
32+
STRIP_FROM_INC_PATH =
33+
SHORT_NAMES = NO
34+
JAVADOC_AUTOBRIEF = NO
35+
QT_AUTOBRIEF = NO
36+
MULTILINE_CPP_IS_BRIEF = NO
37+
INHERIT_DOCS = YES
38+
SEPARATE_MEMBER_PAGES = NO
39+
TAB_SIZE = 4
40+
ALIASES =
41+
TCL_SUBST =
42+
OPTIMIZE_OUTPUT_FOR_C = NO
43+
OPTIMIZE_OUTPUT_JAVA = YES
44+
OPTIMIZE_FOR_FORTRAN = NO
45+
OPTIMIZE_OUTPUT_VHDL = NO
46+
EXTENSION_MAPPING =
47+
MARKDOWN_SUPPORT = YES
48+
AUTOLINK_SUPPORT = YES
49+
BUILTIN_STL_SUPPORT = NO
50+
CPP_CLI_SUPPORT = NO
51+
SIP_SUPPORT = NO
52+
IDL_PROPERTY_SUPPORT = YES
53+
DISTRIBUTE_GROUP_DOC = NO
54+
GROUP_NESTED_COMPOUNDS = NO
55+
SUBGROUPING = YES
56+
INLINE_GROUPED_CLASSES = NO
57+
INLINE_SIMPLE_STRUCTS = NO
58+
TYPEDEF_HIDES_STRUCT = NO
59+
LOOKUP_CACHE_SIZE = 0
60+
#---------------------------------------------------------------------------
61+
# Build related configuration options
62+
#---------------------------------------------------------------------------
63+
EXTRACT_ALL = NO
64+
EXTRACT_PRIVATE = NO
65+
EXTRACT_PACKAGE = NO
66+
EXTRACT_STATIC = NO
67+
EXTRACT_LOCAL_CLASSES = YES
68+
EXTRACT_LOCAL_METHODS = NO
69+
EXTRACT_ANON_NSPACES = NO
70+
HIDE_UNDOC_MEMBERS = NO
71+
HIDE_UNDOC_CLASSES = NO
72+
HIDE_FRIEND_COMPOUNDS = NO
73+
HIDE_IN_BODY_DOCS = NO
74+
INTERNAL_DOCS = NO
75+
CASE_SENSE_NAMES = NO
76+
HIDE_SCOPE_NAMES = NO
77+
HIDE_COMPOUND_REFERENCE= NO
78+
SHOW_INCLUDE_FILES = YES
79+
SHOW_GROUPED_MEMB_INC = NO
80+
FORCE_LOCAL_INCLUDES = NO
81+
INLINE_INFO = YES
82+
SORT_MEMBER_DOCS = YES
83+
SORT_BRIEF_DOCS = NO
84+
SORT_MEMBERS_CTORS_1ST = NO
85+
SORT_GROUP_NAMES = NO
86+
SORT_BY_SCOPE_NAME = NO
87+
STRICT_PROTO_MATCHING = NO
88+
GENERATE_TODOLIST = YES
89+
GENERATE_TESTLIST = YES
90+
GENERATE_BUGLIST = YES
91+
GENERATE_DEPRECATEDLIST= YES
92+
ENABLED_SECTIONS =
93+
MAX_INITIALIZER_LINES = 30
94+
SHOW_USED_FILES = YES
95+
SHOW_FILES = YES
96+
SHOW_NAMESPACES = YES
97+
FILE_VERSION_FILTER =
98+
LAYOUT_FILE =
99+
CITE_BIB_FILES =
100+
#---------------------------------------------------------------------------
101+
# Configuration options related to warning and progress messages
102+
#---------------------------------------------------------------------------
103+
QUIET = NO
104+
WARNINGS = YES
105+
WARN_IF_UNDOCUMENTED = YES
106+
WARN_IF_DOC_ERROR = YES
107+
WARN_NO_PARAMDOC = NO
108+
WARN_AS_ERROR = NO
109+
WARN_FORMAT = "$file:$line: $text"
110+
WARN_LOGFILE =
111+
#---------------------------------------------------------------------------
112+
# Configuration options related to the input files
113+
#---------------------------------------------------------------------------
114+
INPUT = README.md
115+
INPUT += lib60870
116+
117+
INPUT_ENCODING = UTF-8
118+
FILE_PATTERNS = *.c \
119+
*.cc \
120+
*.cxx \
121+
*.cpp \
122+
*.c++ \
123+
*.java \
124+
*.ii \
125+
*.ixx \
126+
*.ipp \
127+
*.i++ \
128+
*.inl \
129+
*.idl \
130+
*.ddl \
131+
*.odl \
132+
*.h \
133+
*.hh \
134+
*.hxx \
135+
*.hpp \
136+
*.h++ \
137+
*.cs \
138+
*.d \
139+
*.php \
140+
*.php4 \
141+
*.php5 \
142+
*.phtml \
143+
*.inc \
144+
*.m \
145+
*.markdown \
146+
*.md \
147+
*.mm \
148+
*.dox \
149+
*.py \
150+
*.pyw \
151+
*.f90 \
152+
*.f \
153+
*.for \
154+
*.tcl \
155+
*.vhd \
156+
*.vhdl \
157+
*.ucf \
158+
*.qsf \
159+
*.as \
160+
*.js
161+
RECURSIVE = YES
162+
EXCLUDE =
163+
EXCLUDE_SYMLINKS = NO
164+
EXCLUDE_PATTERNS =
165+
EXCLUDE_SYMBOLS =
166+
EXAMPLE_PATH = examples
167+
EXAMPLE_PATTERNS = *
168+
EXAMPLE_RECURSIVE = NO
169+
IMAGE_PATH =
170+
INPUT_FILTER =
171+
FILTER_PATTERNS =
172+
FILTER_SOURCE_FILES = NO
173+
FILTER_SOURCE_PATTERNS =
174+
USE_MDFILE_AS_MAINPAGE = README.md
175+
#---------------------------------------------------------------------------
176+
# Configuration options related to source browsing
177+
#---------------------------------------------------------------------------
178+
SOURCE_BROWSER = NO
179+
INLINE_SOURCES = NO
180+
STRIP_CODE_COMMENTS = YES
181+
REFERENCED_BY_RELATION = NO
182+
REFERENCES_RELATION = NO
183+
REFERENCES_LINK_SOURCE = YES
184+
SOURCE_TOOLTIPS = YES
185+
USE_HTAGS = NO
186+
VERBATIM_HEADERS = YES
187+
CLANG_ASSISTED_PARSING = NO
188+
CLANG_OPTIONS =
189+
#---------------------------------------------------------------------------
190+
# Configuration options related to the alphabetical class index
191+
#---------------------------------------------------------------------------
192+
ALPHABETICAL_INDEX = YES
193+
COLS_IN_ALPHA_INDEX = 5
194+
IGNORE_PREFIX =
195+
#---------------------------------------------------------------------------
196+
# Configuration options related to the HTML output
197+
#---------------------------------------------------------------------------
198+
GENERATE_HTML = YES
199+
HTML_OUTPUT = html
200+
HTML_FILE_EXTENSION = .html
201+
HTML_HEADER =
202+
HTML_FOOTER =
203+
HTML_STYLESHEET =
204+
HTML_EXTRA_STYLESHEET =
205+
HTML_EXTRA_FILES =
206+
HTML_COLORSTYLE_HUE = 220
207+
HTML_COLORSTYLE_SAT = 100
208+
HTML_COLORSTYLE_GAMMA = 80
209+
HTML_TIMESTAMP = NO
210+
HTML_DYNAMIC_SECTIONS = NO
211+
HTML_INDEX_NUM_ENTRIES = 100
212+
GENERATE_DOCSET = NO
213+
DOCSET_FEEDNAME = "Doxygen generated docs"
214+
DOCSET_BUNDLE_ID = org.doxygen.Project
215+
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
216+
DOCSET_PUBLISHER_NAME = Publisher
217+
GENERATE_HTMLHELP = NO
218+
CHM_FILE =
219+
HHC_LOCATION =
220+
GENERATE_CHI = NO
221+
CHM_INDEX_ENCODING =
222+
BINARY_TOC = NO
223+
TOC_EXPAND = NO
224+
GENERATE_QHP = NO
225+
QCH_FILE =
226+
QHP_NAMESPACE = org.doxygen.Project
227+
QHP_VIRTUAL_FOLDER = doc
228+
QHP_CUST_FILTER_NAME =
229+
QHP_CUST_FILTER_ATTRS =
230+
QHP_SECT_FILTER_ATTRS =
231+
QHG_LOCATION =
232+
GENERATE_ECLIPSEHELP = NO
233+
ECLIPSE_DOC_ID = org.doxygen.Project
234+
DISABLE_INDEX = NO
235+
GENERATE_TREEVIEW = YES
236+
ENUM_VALUES_PER_LINE = 4
237+
TREEVIEW_WIDTH = 250
238+
EXT_LINKS_IN_WINDOW = NO
239+
FORMULA_FONTSIZE = 10
240+
FORMULA_TRANSPARENT = YES
241+
USE_MATHJAX = NO
242+
MATHJAX_FORMAT = HTML-CSS
243+
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
244+
MATHJAX_EXTENSIONS =
245+
MATHJAX_CODEFILE =
246+
SEARCHENGINE = YES
247+
SERVER_BASED_SEARCH = NO
248+
EXTERNAL_SEARCH = NO
249+
SEARCHENGINE_URL =
250+
SEARCHDATA_FILE = searchdata.xml
251+
EXTERNAL_SEARCH_ID =
252+
EXTRA_SEARCH_MAPPINGS =
253+
#---------------------------------------------------------------------------
254+
# Configuration options related to the LaTeX output
255+
#---------------------------------------------------------------------------
256+
GENERATE_LATEX = NO
257+
LATEX_OUTPUT = latex
258+
LATEX_CMD_NAME = latex
259+
MAKEINDEX_CMD_NAME = makeindex
260+
COMPACT_LATEX = NO
261+
PAPER_TYPE = a4
262+
EXTRA_PACKAGES =
263+
LATEX_HEADER =
264+
LATEX_FOOTER =
265+
LATEX_EXTRA_STYLESHEET =
266+
LATEX_EXTRA_FILES =
267+
PDF_HYPERLINKS = YES
268+
USE_PDFLATEX = YES
269+
LATEX_BATCHMODE = NO
270+
LATEX_HIDE_INDICES = NO
271+
LATEX_SOURCE_CODE = NO
272+
LATEX_BIB_STYLE = plain
273+
LATEX_TIMESTAMP = NO
274+
#---------------------------------------------------------------------------
275+
# Configuration options related to the RTF output
276+
#---------------------------------------------------------------------------
277+
GENERATE_RTF = NO
278+
RTF_OUTPUT = rtf
279+
COMPACT_RTF = NO
280+
RTF_HYPERLINKS = NO
281+
RTF_STYLESHEET_FILE =
282+
RTF_EXTENSIONS_FILE =
283+
RTF_SOURCE_CODE = NO
284+
#---------------------------------------------------------------------------
285+
# Configuration options related to the man page output
286+
#---------------------------------------------------------------------------
287+
GENERATE_MAN = NO
288+
MAN_OUTPUT = man
289+
MAN_EXTENSION = .3
290+
MAN_SUBDIR =
291+
MAN_LINKS = NO
292+
#---------------------------------------------------------------------------
293+
# Configuration options related to the XML output
294+
#---------------------------------------------------------------------------
295+
GENERATE_XML = NO
296+
XML_OUTPUT = xml
297+
XML_PROGRAMLISTING = YES
298+
#---------------------------------------------------------------------------
299+
# Configuration options related to the DOCBOOK output
300+
#---------------------------------------------------------------------------
301+
GENERATE_DOCBOOK = NO
302+
DOCBOOK_OUTPUT = docbook
303+
DOCBOOK_PROGRAMLISTING = NO
304+
#---------------------------------------------------------------------------
305+
# Configuration options for the AutoGen Definitions output
306+
#---------------------------------------------------------------------------
307+
GENERATE_AUTOGEN_DEF = NO
308+
#---------------------------------------------------------------------------
309+
# Configuration options related to the Perl module output
310+
#---------------------------------------------------------------------------
311+
GENERATE_PERLMOD = NO
312+
PERLMOD_LATEX = NO
313+
PERLMOD_PRETTY = YES
314+
PERLMOD_MAKEVAR_PREFIX =
315+
#---------------------------------------------------------------------------
316+
# Configuration options related to the preprocessor
317+
#---------------------------------------------------------------------------
318+
ENABLE_PREPROCESSING = YES
319+
MACRO_EXPANSION = NO
320+
EXPAND_ONLY_PREDEF = NO
321+
SEARCH_INCLUDES = YES
322+
INCLUDE_PATH =
323+
INCLUDE_FILE_PATTERNS =
324+
PREDEFINED =
325+
EXPAND_AS_DEFINED =
326+
SKIP_FUNCTION_MACROS = YES
327+
#---------------------------------------------------------------------------
328+
# Configuration options related to external references
329+
#---------------------------------------------------------------------------
330+
TAGFILES =
331+
GENERATE_TAGFILE =
332+
ALLEXTERNALS = NO
333+
EXTERNAL_GROUPS = YES
334+
EXTERNAL_PAGES = YES
335+
PERL_PATH = /usr/bin/perl
336+
#---------------------------------------------------------------------------
337+
# Configuration options related to the dot tool
338+
#---------------------------------------------------------------------------
339+
CLASS_DIAGRAMS = YES
340+
MSCGEN_PATH =
341+
DIA_PATH =
342+
HIDE_UNDOC_RELATIONS = YES
343+
HAVE_DOT = YES
344+
DOT_NUM_THREADS = 0
345+
DOT_FONTNAME = Helvetica
346+
DOT_FONTSIZE = 10
347+
DOT_FONTPATH =
348+
CLASS_GRAPH = YES
349+
COLLABORATION_GRAPH = YES
350+
GROUP_GRAPHS = YES
351+
UML_LOOK = NO
352+
UML_LIMIT_NUM_FIELDS = 10
353+
TEMPLATE_RELATIONS = NO
354+
INCLUDE_GRAPH = YES
355+
INCLUDED_BY_GRAPH = YES
356+
CALL_GRAPH = NO
357+
CALLER_GRAPH = NO
358+
GRAPHICAL_HIERARCHY = YES
359+
DIRECTORY_GRAPH = YES
360+
DOT_IMAGE_FORMAT = png
361+
INTERACTIVE_SVG = NO
362+
DOT_PATH =
363+
DOTFILE_DIRS =
364+
MSCFILE_DIRS =
365+
DIAFILE_DIRS =
366+
PLANTUML_JAR_PATH =
367+
PLANTUML_INCLUDE_PATH =
368+
DOT_GRAPH_MAX_NODES = 50
369+
MAX_DOT_GRAPH_DEPTH = 0
370+
DOT_TRANSPARENT = NO
371+
DOT_MULTI_TARGETS = NO
372+
GENERATE_LEGEND = YES
373+
DOT_CLEANUP = YES
374+

doxygen/mz-automation.ico

5.56 KB
Binary file not shown.

user_guide_dotnet.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
= lib60870.NET 2.2 User Guide
2-
Michael Zillgith
2+
Copyright 2019 MZ Automation GmbH
33

44
== Introduction
55

0 commit comments

Comments
 (0)