← Back to branch summary

~thomas-voss/location-service/fix-1347887

« back to all changes in this revision

Viewing changes to doc/Doxyfile.in

This MP consolidates multiple related changes together, with the goal of:

(1.) Make the service instance accessible via a cli. Useful for testing scenarios.
(2.) To cut down time-to-first-fix (ttff) by:
  (2.1) Leveraging SUPL and other supplementary data downloaded over ordinary data connections.
  (2.2) Enabling network-based positioning providers to acquire fast position estimates.

In more detail:

* Added tests for daemon and cli.
* Unified daemon and cli header and implementation files.
* Add a command-line interface to the service.
* Split up provider selection policy to rely on an interface ProviderEnumerator to ease in testing.
* Trimmed down on types.
* Removed connectivity API draft to prepare for simpler approach.
* Refactored includes.
* Added a configuration option to handle cell and wifi ID reporting.
* Add a mock for a connectivity API exposed to providers and reporters.
* Add units for connectivity api.
* Refactor cell class into namespace radio. Fixes: 1226204, 1248973, 1281817

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/Doxyfile.in
32
32
# This could be handy for archiving the generated documentation or
33
33
# if some version control system is used.
34
34
 
35
 
PROJECT_NUMBER         = @UBUNTU_LOCATION_SERVICE_VERSION_MAJOR@.@UBUNTU_LOCATION_SERVICE_VERSION_MINOR@.@UBUNTU_LOCATION_SERVICE_VERSION_PATCH@
 
35
PROJECT_NUMBER         = @LOCATION_SERVICE_VERSION_MAJOR@.@LOCATION_SERVICE_VERSION_MINOR@.@LOCATION_SERVICE_VERSION_PATCH@
36
36
 
37
37
# Using the PROJECT_BRIEF tag one can provide an optional one line description
38
38
# for a project that appears at the top of each page and should give viewer
39
39
# a quick idea about the purpose of the project. Keep the description short.
40
40
 
41
 
PROJECT_BRIEF          =
 
41
PROJECT_BRIEF          = "An aggregating location service providing positioning and geocoding capabilities to applications."
42
42
 
43
43
# With the PROJECT_LOGO tag one can specify an logo or icon that is
44
44
# included in the documentation. The maximum height of the logo should not
266
266
# func(std::string) {}). This also makes the inheritance and collaboration
267
267
# diagrams that involve STL classes more complete and accurate.
268
268
 
269
 
BUILTIN_STL_SUPPORT    = NO
 
269
BUILTIN_STL_SUPPORT    = YES
270
270
 
271
271
# If you use Microsoft's C++/CLI language, you should set this option to YES to
272
272
# enable parsing support.
365
365
# Private class members and static file members will be hidden unless
366
366
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
367
367
 
368
 
EXTRACT_ALL            = NO
 
368
EXTRACT_ALL            = YES
369
369
 
370
370
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
371
371
# will be included in the documentation.
380
380
# If the EXTRACT_STATIC tag is set to YES all static members of a file
381
381
# will be included in the documentation.
382
382
 
383
 
EXTRACT_STATIC         = NO
 
383
EXTRACT_STATIC         = YES
384
384
 
385
385
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
386
386
# defined locally in source files will be included in the documentation.
423
423
# If set to NO (the default) these declarations will be included in the
424
424
# documentation.
425
425
 
426
 
HIDE_FRIEND_COMPOUNDS  = NO
 
426
HIDE_FRIEND_COMPOUNDS  = YES
427
427
 
428
428
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
429
429
# documentation blocks found inside the body of a function.
668
668
# directories like "/usr/src/myproject". Separate the files or directories
669
669
# with spaces.
670
670
 
671
 
INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/../include
 
671
INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@ @CMAKE_CURRENT_SOURCE_DIR@/../include
672
672
 
673
673
# This tag can be used to specify the character encoding of the source files
674
674
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
728
728
# directories that contain example code fragments that are included (see
729
729
# the \include command).
730
730
 
731
 
EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/../examples
 
731
EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/../tests
732
732
 
733
733
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
734
734
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
791
791
# This can be useful if you have a project on for instance GitHub and want reuse
792
792
# the introduction page also for the doxygen output.
793
793
 
794
 
USE_MDFILE_AS_MAINPAGE =
 
794
USE_MDFILE_AS_MAINPAGE = @CMAKE_SOURCE_DIR@/README.md
795
795
 
796
796
#---------------------------------------------------------------------------
797
797
# configuration options related to source browsing
807
807
# Setting the INLINE_SOURCES tag to YES will include the body
808
808
# of functions and classes directly in the documentation.
809
809
 
810
 
INLINE_SOURCES         = YES
 
810
INLINE_SOURCES         = NO
811
811
 
812
812
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
813
813
# doxygen to hide any special comment blocks from generated source code
929
929
# robust against future updates. Doxygen will copy the style sheet file to
930
930
# the output directory.
931
931
 
932
 
HTML_EXTRA_STYLESHEET  =
 
932
HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/extra.css
933
933
 
934
934
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
935
935
# other source files which should be copied to the HTML output directory. Note
975
975
# documentation will contain sections that can be hidden and shown after the
976
976
# page has loaded.
977
977
 
978
 
HTML_DYNAMIC_SECTIONS  = NO
 
978
HTML_DYNAMIC_SECTIONS  = YES
979
979
 
980
980
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
981
981
# entries shown in the various tree structured indices initially; the user
1145
1145
# navigation tree you can set this option to NO if you already set
1146
1146
# GENERATE_TREEVIEW to YES.
1147
1147
 
1148
 
DISABLE_INDEX          = NO
 
1148
DISABLE_INDEX          = YES
1149
1149
 
1150
1150
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1151
1151
# structure should be generated to display hierarchical information.
1157
1157
# Since the tree basically has the same information as the tab index you
1158
1158
# could consider to set DISABLE_INDEX to NO when enabling this option.
1159
1159
 
1160
 
GENERATE_TREEVIEW      = NO
 
1160
GENERATE_TREEVIEW      = YES
1161
1161
 
1162
1162
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1163
1163
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1234
1234
# typically be disabled. For large projects the javascript based search engine
1235
1235
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1236
1236
 
1237
 
SEARCHENGINE           = NO 
 
1237
SEARCHENGINE           = NO
1238
1238
 
1239
1239
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1240
1240
# implemented using a web server instead of a web client using Javascript.
1293
1293
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1294
1294
# generate Latex output.
1295
1295
 
1296
 
GENERATE_LATEX         = NO
 
1296
GENERATE_LATEX         = YES
1297
1297
 
1298
1298
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1299
1299
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1319
1319
# LaTeX documents. This may be useful for small projects and may help to
1320
1320
# save some trees in general.
1321
1321
 
1322
 
COMPACT_LATEX          = NO
 
1322
COMPACT_LATEX          = YES 
1323
1323
 
1324
1324
# The PAPER_TYPE tag can be used to set the paper type that is used
1325
1325
# by the printer. Possible values are: a4, letter, legal and
1377
1377
# Note that which sources are shown also depends on other settings
1378
1378
# such as SOURCE_BROWSER.
1379
1379
 
1380
 
LATEX_SOURCE_CODE      = NO
 
1380
LATEX_SOURCE_CODE      = NO 
1381
1381
 
1382
1382
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1383
1383
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1434
1434
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1435
1435
# generate man pages
1436
1436
 
1437
 
GENERATE_MAN           = NO
 
1437
GENERATE_MAN           = YES
1438
1438
 
1439
1439
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1440
1440
# If a relative path is entered the value of OUTPUT_DIRECTORY will be