Skip to content

Commit 43d1648

Browse files
committed
Started reworking API docs via Doxygen
1 parent 5291b3f commit 43d1648

File tree

4 files changed

+195
-200
lines changed

4 files changed

+195
-200
lines changed

Doxyfile

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,20 @@ DOXYFILE_ENCODING = UTF-8
2525
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
2626
# by quotes) that should identify the project.
2727

28-
PROJECT_NAME =
28+
PROJECT_NAME = Privateer
2929

3030
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
3131
# This could be handy for archiving the generated documentation or
3232
# if some version control system is used.
3333

34-
PROJECT_NUMBER =
34+
PROJECT_NUMBER = MKIII
3535

3636
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
3737
# base path where the generated documentation will be put.
3838
# If a relative path is entered, it will be relative to the location
3939
# where doxygen was started. If left blank the current directory will be used.
4040

41-
OUTPUT_DIRECTORY = ../doc
41+
OUTPUT_DIRECTORY = doc
4242

4343
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
4444
# 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -159,7 +159,7 @@ MULTILINE_CPP_IS_BRIEF = NO
159159
# member inherits the documentation from any documented member that it
160160
# re-implements.
161161

162-
INHERIT_DOCS = YES
162+
INHERIT_DOCS = NO
163163

164164
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165165
# a new page for each member. If set to NO, the documentation of a member will
@@ -225,7 +225,7 @@ EXTENSION_MAPPING =
225225
# func(std::string) {}). This also make the inheritance and collaboration
226226
# diagrams that involve STL classes more complete and accurate.
227227

228-
BUILTIN_STL_SUPPORT = NO
228+
BUILTIN_STL_SUPPORT = YES
229229

230230
# If you use Microsoft's C++/CLI language, you should set this option to YES to
231231
# enable parsing support.
@@ -297,7 +297,7 @@ SYMBOL_CACHE_SIZE = 0
297297
# Private class members and static file members will be hidden unless
298298
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
299299

300-
EXTRACT_ALL = YES
300+
EXTRACT_ALL = NO
301301

302302
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
303303
# will be included in the documentation.
@@ -313,7 +313,7 @@ EXTRACT_STATIC = NO
313313
# defined locally in source files will be included in the documentation.
314314
# If set to NO only classes defined in header files are included.
315315

316-
EXTRACT_LOCAL_CLASSES = YES
316+
EXTRACT_LOCAL_CLASSES = NO
317317

318318
# This flag is only useful for Objective-C code. When set to YES local
319319
# methods, which are defined in the implementation section but not in
@@ -343,7 +343,7 @@ HIDE_UNDOC_MEMBERS = NO
343343
# If set to NO (the default) these classes will be included in the various
344344
# overviews. This option has no effect if EXTRACT_ALL is enabled.
345345

346-
HIDE_UNDOC_CLASSES = NO
346+
HIDE_UNDOC_CLASSES = YES
347347

348348
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
349349
# friend (class|struct|union) declarations.
@@ -396,7 +396,7 @@ INLINE_INFO = YES
396396
# alphabetically by member name. If set to NO the members will appear in
397397
# declaration order.
398398

399-
SORT_MEMBER_DOCS = YES
399+
SORT_MEMBER_DOCS = NO
400400

401401
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
402402
# brief documentation of file, namespace and class members alphabetically
@@ -597,7 +597,7 @@ RECURSIVE = NO
597597
# excluded from the INPUT source files. This way you can easily exclude a
598598
# subdirectory from a directory tree whose root is specified with the INPUT tag.
599599

600-
EXCLUDE =
600+
EXCLUDE = privateer-frontend_scriptingPYTHON_wrap.cxx privateer.py
601601

602602
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
603603
# directories that are symbolic links (a Unix filesystem feature) are excluded

0 commit comments

Comments
 (0)