Skip to content

Commit 42800c1

Browse files
AlcpzAlcpz
committed
Updated documentation for the whole repo
1 parent c609580 commit 42800c1

22 files changed

+748
-38
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,5 @@ cmake_install.cmake
88
install_manifest.txt
99
compile_commands.json
1010
CTestTestfile.cmake
11+
.cproject
12+
.project

‎CMakeLists.txt

+26
Original file line numberDiff line numberDiff line change
@@ -92,3 +92,29 @@ ENDIF(CUNIT_FOUND)
9292

9393
add_subdirectory(src)
9494

95+
96+
find_package(Doxygen)
97+
option(BUILD_DOCUMENTATION "Create and install the HTML based API
98+
documentation (requires Doxygen)" ${DOXYGEN_FOUND})
99+
100+
if(BUILD_DOCUMENTATION)
101+
if(NOT DOXYGEN_FOUND)
102+
message(FATAL_ERROR "Doxygen is needed to build the documentation.")
103+
endif()
104+
105+
set(doxyfile_in config/Doxyfile.in)
106+
set(doxyfile ${CMAKE_CURRENT_BINARY_DIR}/config/Doxyfile)
107+
108+
configure_file(${doxyfile_in} ${doxyfile} @ONLY)
109+
110+
message("Doxygen build started.")
111+
112+
add_custom_target(doc
113+
COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile}
114+
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
115+
COMMENT "Generating API documentation with Doxygen"
116+
VERBATIM)
117+
118+
endif()
119+
120+

‎README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ More details can be found in the associated publications.
2020
Documentation
2121
-------------
2222

23-
Doxygen-generated documentation will be added soon.
23+
Doxygen-generated can be found at:
24+
25+
https://hpc-ull.github.io/ullmf/
2426

2527
License
2628
-------

‎config/Doxyfile.in

+314
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,314 @@
1+
# Doxyfile 1.8.7
2+
3+
#---------------------------------------------------------------------------
4+
# Project related configuration options
5+
#---------------------------------------------------------------------------
6+
DOXYFILE_ENCODING = UTF-8
7+
PROJECT_NAME = @PROJECT_NAME@
8+
PROJECT_NUMBER = @PROJECT_VERSION@
9+
PROJECT_BRIEF = "Ull Multiobjective Framework"
10+
PROJECT_LOGO =
11+
OUTPUT_DIRECTORY = doxygen-doc/
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 =
18+
ALWAYS_DETAILED_SEC = NO
19+
INLINE_INHERITED_MEMB = NO
20+
FULL_PATH_NAMES = NO
21+
STRIP_FROM_PATH = ./ doc/ include/
22+
STRIP_FROM_INC_PATH =
23+
SHORT_NAMES = NO
24+
JAVADOC_AUTOBRIEF = YES
25+
QT_AUTOBRIEF = NO
26+
MULTILINE_CPP_IS_BRIEF = NO
27+
INHERIT_DOCS = YES
28+
SEPARATE_MEMBER_PAGES = NO
29+
TAB_SIZE = 8
30+
ALIASES =
31+
TCL_SUBST =
32+
OPTIMIZE_OUTPUT_FOR_C = YES
33+
OPTIMIZE_OUTPUT_JAVA = NO
34+
OPTIMIZE_FOR_FORTRAN = NO
35+
OPTIMIZE_OUTPUT_VHDL = NO
36+
EXTENSION_MAPPING = no_extension=md
37+
MARKDOWN_SUPPORT = YES
38+
AUTOLINK_SUPPORT = YES
39+
BUILTIN_STL_SUPPORT = NO
40+
CPP_CLI_SUPPORT = NO
41+
SIP_SUPPORT = NO
42+
IDL_PROPERTY_SUPPORT = YES
43+
DISTRIBUTE_GROUP_DOC = NO
44+
SUBGROUPING = YES
45+
INLINE_GROUPED_CLASSES = NO
46+
INLINE_SIMPLE_STRUCTS = NO
47+
TYPEDEF_HIDES_STRUCT = NO
48+
LOOKUP_CACHE_SIZE = 0
49+
#---------------------------------------------------------------------------
50+
# Build related configuration options
51+
#---------------------------------------------------------------------------
52+
EXTRACT_ALL = NO
53+
EXTRACT_PRIVATE = NO
54+
EXTRACT_PACKAGE = NO
55+
EXTRACT_STATIC = NO
56+
EXTRACT_LOCAL_CLASSES = YES
57+
EXTRACT_LOCAL_METHODS = NO
58+
EXTRACT_ANON_NSPACES = NO
59+
HIDE_UNDOC_MEMBERS = NO
60+
HIDE_UNDOC_CLASSES = NO
61+
HIDE_FRIEND_COMPOUNDS = NO
62+
HIDE_IN_BODY_DOCS = NO
63+
INTERNAL_DOCS = NO
64+
CASE_SENSE_NAMES = YES
65+
HIDE_SCOPE_NAMES = NO
66+
SHOW_INCLUDE_FILES = YES
67+
SHOW_GROUPED_MEMB_INC = NO
68+
FORCE_LOCAL_INCLUDES = NO
69+
INLINE_INFO = YES
70+
SORT_MEMBER_DOCS = YES
71+
SORT_BRIEF_DOCS = NO
72+
SORT_MEMBERS_CTORS_1ST = NO
73+
SORT_GROUP_NAMES = NO
74+
SORT_BY_SCOPE_NAME = NO
75+
STRICT_PROTO_MATCHING = NO
76+
GENERATE_TODOLIST = YES
77+
GENERATE_TESTLIST = YES
78+
GENERATE_BUGLIST = YES
79+
GENERATE_DEPRECATEDLIST= YES
80+
ENABLED_SECTIONS =
81+
MAX_INITIALIZER_LINES = 30
82+
SHOW_USED_FILES = YES
83+
SHOW_FILES = YES
84+
SHOW_NAMESPACES = YES
85+
FILE_VERSION_FILTER =
86+
LAYOUT_FILE =
87+
CITE_BIB_FILES =
88+
#---------------------------------------------------------------------------
89+
# Configuration options related to warning and progress messages
90+
#---------------------------------------------------------------------------
91+
QUIET = NO
92+
WARNINGS = YES
93+
WARN_IF_UNDOCUMENTED = YES
94+
WARN_IF_DOC_ERROR = YES
95+
WARN_NO_PARAMDOC = YES
96+
WARN_FORMAT = "$file:$line: $text"
97+
WARN_LOGFILE =
98+
#---------------------------------------------------------------------------
99+
# Configuration options related to the input files
100+
#---------------------------------------------------------------------------
101+
INPUT = @PROJECT_SOURCE_DIR@/include/ @PROJECT_SOURCE_DIR@/include/ullmf/ @PROJECT_SOURCE_DIR@/src/ \
102+
@PROJECT_SOURCE_DIR@/doc/groups.dox \
103+
@PROJECT_SOURCE_DIR@/README.md \
104+
@PROJECT_SOURCE_DIR@/INSTALL \
105+
@PROJECT_SOURCE_DIR@/doc/configuration.md \
106+
@PROJECT_SOURCE_DIR@/doc/json.md \
107+
@PROJECT_SOURCE_DIR@/doc/usage.md
108+
INPUT_ENCODING = UTF-8
109+
FILE_PATTERNS =
110+
RECURSIVE = NO
111+
EXCLUDE =
112+
EXCLUDE_SYMLINKS = NO
113+
EXCLUDE_PATTERNS =
114+
EXCLUDE_SYMBOLS =
115+
EXAMPLE_PATH =
116+
EXAMPLE_PATTERNS =
117+
EXAMPLE_RECURSIVE = NO
118+
IMAGE_PATH =
119+
INPUT_FILTER =
120+
FILTER_PATTERNS =
121+
FILTER_SOURCE_FILES = NO
122+
FILTER_SOURCE_PATTERNS =
123+
USE_MDFILE_AS_MAINPAGE = @PROJECT_SOURCE_DIR@/README.md
124+
#---------------------------------------------------------------------------
125+
# Configuration options related to source browsing
126+
#---------------------------------------------------------------------------
127+
SOURCE_BROWSER = NO
128+
INLINE_SOURCES = NO
129+
STRIP_CODE_COMMENTS = YES
130+
REFERENCED_BY_RELATION = NO
131+
REFERENCES_RELATION = NO
132+
REFERENCES_LINK_SOURCE = YES
133+
SOURCE_TOOLTIPS = YES
134+
USE_HTAGS = NO
135+
VERBATIM_HEADERS = NO
136+
#---------------------------------------------------------------------------
137+
# Configuration options related to the alphabetical class index
138+
#---------------------------------------------------------------------------
139+
ALPHABETICAL_INDEX = YES
140+
COLS_IN_ALPHA_INDEX = 5
141+
IGNORE_PREFIX = ullmf_ ULLMF_
142+
#---------------------------------------------------------------------------
143+
# Configuration options related to the HTML output
144+
#---------------------------------------------------------------------------
145+
GENERATE_HTML = YES
146+
HTML_OUTPUT = html
147+
HTML_FILE_EXTENSION = .html
148+
HTML_HEADER =
149+
HTML_FOOTER =
150+
HTML_STYLESHEET =
151+
HTML_EXTRA_STYLESHEET =
152+
HTML_EXTRA_FILES =
153+
HTML_COLORSTYLE_HUE = 120
154+
HTML_COLORSTYLE_SAT = 100
155+
HTML_COLORSTYLE_GAMMA = 100
156+
HTML_TIMESTAMP = YES
157+
HTML_DYNAMIC_SECTIONS = NO
158+
HTML_INDEX_NUM_ENTRIES = 100
159+
GENERATE_DOCSET = NO
160+
DOCSET_FEEDNAME = "Doxygen generated docs"
161+
DOCSET_BUNDLE_ID = org.doxygen.Project
162+
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
163+
DOCSET_PUBLISHER_NAME = Publisher
164+
GENERATE_HTMLHELP = NO
165+
CHM_FILE =
166+
HHC_LOCATION =
167+
GENERATE_CHI = NO
168+
CHM_INDEX_ENCODING =
169+
BINARY_TOC = NO
170+
TOC_EXPAND = NO
171+
GENERATE_QHP = NO
172+
QCH_FILE =
173+
QHP_NAMESPACE = org.doxygen.Project
174+
QHP_VIRTUAL_FOLDER = doc
175+
QHP_CUST_FILTER_NAME =
176+
QHP_CUST_FILTER_ATTRS =
177+
QHP_SECT_FILTER_ATTRS =
178+
QHG_LOCATION =
179+
GENERATE_ECLIPSEHELP = NO
180+
ECLIPSE_DOC_ID = org.doxygen.Project
181+
DISABLE_INDEX = YES
182+
GENERATE_TREEVIEW = YES
183+
ENUM_VALUES_PER_LINE = 1
184+
TREEVIEW_WIDTH = 250
185+
EXT_LINKS_IN_WINDOW = NO
186+
FORMULA_FONTSIZE = 10
187+
FORMULA_TRANSPARENT = YES
188+
USE_MATHJAX = NO
189+
MATHJAX_FORMAT = HTML-CSS
190+
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
191+
MATHJAX_EXTENSIONS =
192+
MATHJAX_CODEFILE =
193+
SEARCHENGINE = YES
194+
SERVER_BASED_SEARCH = NO
195+
EXTERNAL_SEARCH = NO
196+
SEARCHENGINE_URL =
197+
SEARCHDATA_FILE = searchdata.xml
198+
EXTERNAL_SEARCH_ID =
199+
EXTRA_SEARCH_MAPPINGS =
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 = NO
208+
PAPER_TYPE = a4
209+
EXTRA_PACKAGES =
210+
LATEX_HEADER =
211+
LATEX_FOOTER =
212+
LATEX_EXTRA_FILES =
213+
PDF_HYPERLINKS = YES
214+
USE_PDFLATEX = YES
215+
LATEX_BATCHMODE = NO
216+
LATEX_HIDE_INDICES = NO
217+
LATEX_SOURCE_CODE = NO
218+
LATEX_BIB_STYLE = plain
219+
#---------------------------------------------------------------------------
220+
# Configuration options related to the RTF output
221+
#---------------------------------------------------------------------------
222+
GENERATE_RTF = NO
223+
RTF_OUTPUT = rtf
224+
COMPACT_RTF = NO
225+
RTF_HYPERLINKS = NO
226+
RTF_STYLESHEET_FILE =
227+
RTF_EXTENSIONS_FILE =
228+
#---------------------------------------------------------------------------
229+
# Configuration options related to the man page output
230+
#---------------------------------------------------------------------------
231+
GENERATE_MAN = NO
232+
MAN_OUTPUT = man
233+
MAN_EXTENSION = .3
234+
MAN_SUBDIR =
235+
MAN_LINKS = NO
236+
#---------------------------------------------------------------------------
237+
# Configuration options related to the XML output
238+
#---------------------------------------------------------------------------
239+
GENERATE_XML = NO
240+
XML_OUTPUT = xml
241+
XML_PROGRAMLISTING = YES
242+
#---------------------------------------------------------------------------
243+
# Configuration options related to the DOCBOOK output
244+
#---------------------------------------------------------------------------
245+
GENERATE_DOCBOOK = NO
246+
DOCBOOK_OUTPUT = docbook
247+
#---------------------------------------------------------------------------
248+
# Configuration options for the AutoGen Definitions output
249+
#---------------------------------------------------------------------------
250+
GENERATE_AUTOGEN_DEF = NO
251+
#---------------------------------------------------------------------------
252+
# Configuration options related to the Perl module output
253+
#---------------------------------------------------------------------------
254+
GENERATE_PERLMOD = NO
255+
PERLMOD_LATEX = NO
256+
PERLMOD_PRETTY = YES
257+
PERLMOD_MAKEVAR_PREFIX =
258+
#---------------------------------------------------------------------------
259+
# Configuration options related to the preprocessor
260+
#---------------------------------------------------------------------------
261+
ENABLE_PREPROCESSING = YES
262+
MACRO_EXPANSION = NO
263+
EXPAND_ONLY_PREDEF = NO
264+
SEARCH_INCLUDES = YES
265+
INCLUDE_PATH =
266+
INCLUDE_FILE_PATTERNS =
267+
PREDEFINED =
268+
EXPAND_AS_DEFINED =
269+
SKIP_FUNCTION_MACROS = YES
270+
#---------------------------------------------------------------------------
271+
# Configuration options related to external references
272+
#---------------------------------------------------------------------------
273+
TAGFILES =
274+
GENERATE_TAGFILE =
275+
ALLEXTERNALS = NO
276+
EXTERNAL_GROUPS = YES
277+
EXTERNAL_PAGES = YES
278+
PERL_PATH = /usr/bin/perl
279+
#---------------------------------------------------------------------------
280+
# Configuration options related to the dot tool
281+
#---------------------------------------------------------------------------
282+
CLASS_DIAGRAMS = YES
283+
MSCGEN_PATH =
284+
DIA_PATH =
285+
HIDE_UNDOC_RELATIONS = YES
286+
HAVE_DOT = NO
287+
DOT_NUM_THREADS = 0
288+
DOT_FONTNAME = Helvetica
289+
DOT_FONTSIZE = 10
290+
DOT_FONTPATH =
291+
CLASS_GRAPH = YES
292+
COLLABORATION_GRAPH = YES
293+
GROUP_GRAPHS = YES
294+
UML_LOOK = NO
295+
UML_LIMIT_NUM_FIELDS = 10
296+
TEMPLATE_RELATIONS = NO
297+
INCLUDE_GRAPH = YES
298+
INCLUDED_BY_GRAPH = YES
299+
CALL_GRAPH = NO
300+
CALLER_GRAPH = NO
301+
GRAPHICAL_HIERARCHY = YES
302+
DIRECTORY_GRAPH = YES
303+
DOT_IMAGE_FORMAT = png
304+
INTERACTIVE_SVG = NO
305+
DOT_PATH =
306+
DOTFILE_DIRS =
307+
MSCFILE_DIRS =
308+
DIAFILE_DIRS =
309+
DOT_GRAPH_MAX_NODES = 50
310+
MAX_DOT_GRAPH_DEPTH = 0
311+
DOT_TRANSPARENT = NO
312+
DOT_MULTI_TARGETS = NO
313+
GENERATE_LEGEND = YES
314+
DOT_CLEANUP = YES

0 commit comments

Comments
 (0)