diff --git a/doxyfile_options b/doxyfile_options index fb86945..e2ee325 100644 --- a/doxyfile_options +++ b/doxyfile_options @@ -514,7 +514,7 @@ # and Mac users are advised to set this option to NO. # The default value is: system dependent. -CASE_SENSE_NAMES = YES +CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the @@ -805,7 +805,7 @@ # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. -FILE_PATTERNS = *.h +FILE_PATTERNS = *.h DOXYGEN_FRONTPAGE.md # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -951,7 +951,7 @@ # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = DOXYGEN_FRONTPAGE.md #--------------------------------------------------------------------------- # Configuration options related to source browsing @@ -1430,7 +1430,7 @@ # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -DISABLE_INDEX = YES +DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag @@ -1561,7 +1561,7 @@ # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. -SEARCHENGINE = NO +SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be # implemented using a web server instead of a web client using Javascript. There @@ -1915,7 +1915,7 @@ # captures the structure of the code including all documentation. # The default value is: NO. -GENERATE_XML = YES +GENERATE_XML = NO # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of @@ -1923,7 +1923,7 @@ # The default directory is: xml. # This tag requires that the tag GENERATE_XML is set to YES. -XML_OUTPUT = BUILD/xml +XML_OUTPUT = xml # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program # listings (including syntax highlighting and cross-referencing information) to @@ -2075,7 +2075,6 @@ DEVICE_CRC \ DEVICE_ETHERNET \ DEVICE_EMAC \ - DEVICE_ETH \ DEVICE_FLASH \ DEVICE_I2C \ DEVICE_I2CSLAVE \ @@ -2184,7 +2183,7 @@ # powerful graphs. # The default value is: YES. -CLASS_DIAGRAMS = NO +CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc # command. Doxygen will then run the mscgen tool (see: diff --git a/doxygen_options.json b/doxygen_options.json index 1362e6b..1895c35 100644 --- a/doxygen_options.json +++ b/doxygen_options.json @@ -1,5 +1,5 @@ { - "PROJECT_NAME": "Mbed OS Reference", + "PROJECT_NAME": "\"Mbed OS Reference\"", "ENABLE_PREPROCESSING": "YES", "MACRO_EXPANSION": "YES", "EXPAND_ONLY_PREDEF": "NO", @@ -10,5 +10,38 @@ "EXPAND_AS_DEFINED": "", "SKIP_FUNCTION_MACROS": "NO", "STRIP_CODE_COMMENTS": "NO", - "EXCLUDE_PATTERNS": "*/tools/* */targets/* */features/mbedtls/* */features/storage/cfstore/* */features/storage/FEATURE_STORAGE/* */features/unsupported/* */BUILD/* */rtos/TARGET_CORTEX/rtx*/* */cmsis/* */features/lwipstack/* */nanostack/sal-stack-nanostack/* */nanostack/coap-service/* */ble/generic/* */ble/pal/* */mbed-trace/* */mbed-coap/* */nanostack-libservice/* */mbed-client-randlib/* */nanostack/sal-stack-nanostack-eventloop/* */components/802.15.4_RF/* */components/wifi/* */features/nfc/stack/* */UNITTESTS/*" + "EXCLUDE_PATTERNS": "*/tools/* */targets/* */features/mbedtls/* */features/storage/cfstore/* */features/storage/FEATURE_STORAGE/* */features/unsupported/* */BUILD/* */rtos/TARGET_CORTEX/rtx*/* */cmsis/* */features/lwipstack/* */nanostack/sal-stack-nanostack/* */nanostack/coap-service/* */ble/generic/* */ble/pal/* */mbed-trace/* */mbed-coap/* */nanostack-libservice/* */mbed-client-randlib/* */nanostack/sal-stack-nanostack-eventloop/* */components/802.15.4_RF/* */components/wifi/* */features/nfc/stack/* */UNITTESTS/* */features/cryptocell/*", + "ALPHABETICAL_INDEX": "NO", + "CASE_SENSE_NAMES": "NO", + "DOT_MULTI_TARGETS": "YES", + "EXCLUDE_SYMLINKS": "YES", + "EXTRACT_ANON_NSPACES": "YES", + "EXTRACT_LOCAL_CLASSES": "NO", + "EXTRACT_STATIC": "YES", + "FILE_PATTERNS": "*.h DOXYGEN_FRONTPAGE.md", + "FULL_PATH_NAMES": "NO", + "GENERATE_BUGLIST": "NO", + "GENERATE_LATEX": "NO", + "GENERATE_TESTLIST": "NO", + "GENERATE_TODOLIST": "NO", + "HIDE_SCOPE_NAMES": "YES", + "HIDE_UNDOC_CLASSES": "YES", + "HIDE_UNDOC_MEMBERS": "YES", + "INLINE_INFO": "NO", + "INLINE_INHERITED_MEMB": "YES", + "JAVADOC_AUTOBRIEF": "YES", + "PAPER_TYPE": "a4wide", + "QUIET": "YES", + "REFERENCES_LINK_SOURCE": "NO", + "SHOW_USED_FILES": "NO", + "SOURCE_BROWSER": "YES", + "ALWAYS_DETAILED_SEC": "YES", + + "INPUT": "mbed-os", + "HTML_OUTPUT": "html", + + "RECURSIVE": "YES", + "OPTIMIZE_OUTPUT_FOR_C": "YES", + "USE_MDFILE_AS_MAINPAGE": "DOXYGEN_FRONTPAGE.md", + "SEARCHENGINE": "YES" } diff --git a/features/FEATURE_BLE/DOXYGEN_FRONTPAGE.md b/features/FEATURE_BLE/DOXYGEN_FRONTPAGE.md deleted file mode 100644 index f221277..0000000 --- a/features/FEATURE_BLE/DOXYGEN_FRONTPAGE.md +++ /dev/null @@ -1,30 +0,0 @@ -# BLE API {#mainpage} - -The BLE module within mbed OS offers a high abstraction level for using -Bluetooth Low Energy on multiple platforms. - -This documentation describes the internal structure of the mbed -[BLE API](https://github.com/armmbed/ble). - -For getting started with BLE on mbed, check our [introduction -page](https://docs.mbed.com/docs/ble-intros/en/latest/). - -For mbed OS examples using BLE, check [this -repository](https://github.com/armmbed/ble-examples). For mbed-classic -examples, please refer to [code under mbed.org](https://developer.mbed.org/teams/Bluetooth-Low-Energy/code/). - -## Supported Services - -Currently supported reference services include: - -* [Battery](@ref BatteryService) -* [Device Firmware Update (DFU)](@ref DFUService) -* [Device Information](@ref DeviceInformationService) -* [Health Thermometer](@ref HealthThermometerService) -* [Heart Rate](@ref HeartRateService) -* [UART](@ref UARTService) -* [UriBeacon](@ref URIBeaconConfigService) -* [iBeacon](@ref iBeacon) - -The [documentation](https://docs.mbed.com/docs/ble-intros/en/latest/AdvSamples/Overview/) -contains an overview on how to create new, application-specific services. diff --git a/features/FEATURE_BLE/DOXYGEN_FRONTPAGE_BLE.md b/features/FEATURE_BLE/DOXYGEN_FRONTPAGE_BLE.md new file mode 100644 index 0000000..f221277 --- /dev/null +++ b/features/FEATURE_BLE/DOXYGEN_FRONTPAGE_BLE.md @@ -0,0 +1,30 @@ +# BLE API {#mainpage} + +The BLE module within mbed OS offers a high abstraction level for using +Bluetooth Low Energy on multiple platforms. + +This documentation describes the internal structure of the mbed +[BLE API](https://github.com/armmbed/ble). + +For getting started with BLE on mbed, check our [introduction +page](https://docs.mbed.com/docs/ble-intros/en/latest/). + +For mbed OS examples using BLE, check [this +repository](https://github.com/armmbed/ble-examples). For mbed-classic +examples, please refer to [code under mbed.org](https://developer.mbed.org/teams/Bluetooth-Low-Energy/code/). + +## Supported Services + +Currently supported reference services include: + +* [Battery](@ref BatteryService) +* [Device Firmware Update (DFU)](@ref DFUService) +* [Device Information](@ref DeviceInformationService) +* [Health Thermometer](@ref HealthThermometerService) +* [Heart Rate](@ref HeartRateService) +* [UART](@ref UARTService) +* [UriBeacon](@ref URIBeaconConfigService) +* [iBeacon](@ref iBeacon) + +The [documentation](https://docs.mbed.com/docs/ble-intros/en/latest/AdvSamples/Overview/) +contains an overview on how to create new, application-specific services.