Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature public headers #11073

Merged
merged 10 commits into from
Aug 7, 2019
Merged

Feature public headers #11073

merged 10 commits into from
Aug 7, 2019

Commits on Aug 2, 2019

  1. Drivers/Events/RTOS Public and internal APIs cleanup (#10955) 

    Separate drivers, events, and rtos internal APIs from public APIs.

* Move source files to source subdirs
* Move internal headers to internal subdirs
* Add Doxygen comments for documenting internal and public APIs
* Remove source code from header files in order to remove include pre-processor directives
that included header files not directly used by said header files
* Explicitly include header files instead of implicit inclusions via third-party header files.

Release Notes

This will break user code that was using an internal API as the internal header files have been moved.
This will only break if the user was including the header file using a namespace (i.e #include "foo/bar.h" instead of #include "bar.h"
    @hugueskamba @evedon
    hugueskamba authored and evedon committed Aug 2, 2019
    Configuration menu
    Copy the full SHA
    bfa1b4d View commit details
    Browse the repository at this point in the history

  2. Platform: Separate internal APIs from public APIs 

    Also includes:
* rename `mbed_sleep_manager.c` to `mbed_power_mgmt.c` to match its
  header file
* create Doxygen groups for public and internal APIs
* use relative path to include header files where inconsistent
* update references to internal APIs throughout libraries
* update the copyright year for all modified files
    @hugueskamba @evedon
    hugueskamba authored and evedon committed Aug 2, 2019
    Configuration menu
    Copy the full SHA
    83354e4 View commit details
    Browse the repository at this point in the history

  3. Fixing include files due to latest rebase

    @evedon
    evedon committed Aug 2, 2019
    Configuration menu
    Copy the full SHA
    8013af2 View commit details
    Browse the repository at this point in the history

  4. USB public APIs cleanup (#11034) 

    The contents of the usb directory were moved to appropriate locations and the usb directory removed.

* Public USB headers moved under drivers/
* Internal USB headers moved under drivers/internal/
* USB Source code moved under drivers/source/usb/
* Moved usb/device/hal/ under hal/usb/
* Moved usb/device/USBPhy/ under hal/usb/
* Merged usb/device/targets/ into targets/
* Separated public and private USB API documentation under Doxygen groups drivers-public-api and drivers-internal-api.
    @gpsimenos @evedon
    gpsimenos authored and evedon committed Aug 2, 2019
    Configuration menu
    Copy the full SHA
    df5baf6 View commit details
    Browse the repository at this point in the history

  5. Fix Ethernet driver build (#11096) 

    Include the missing header file inclusion to find the added
MBED_DEPRECATED macro.
    @hugueskamba @evedon
    hugueskamba authored and evedon committed Aug 2, 2019
    Configuration menu
    Copy the full SHA
    c6b0a14 View commit details
    Browse the repository at this point in the history

  6. Change Doxygen groups structure, splitting first by Public/Internal (#… 

    …11105)

* Change Doxygen groups structure, splitting first by Public/Internal

This commit also does the following:
* groups the documentation of related API
* moves `events/internal/equeue.h` to `events/equeue.h`
* merges `events/source/README.md` to `events/README.md`
    @hugueskamba @evedon
    hugueskamba authored and evedon committed Aug 2, 2019
    Configuration menu
    Copy the full SHA
    20f81e1 View commit details
    Browse the repository at this point in the history

  7. Fix CI for branch feature-public-headers (#11093) 

    * Fix rtos include path in NRFCordioHCIDriver
* Flatten USB driver directory structure
* Add missing include for us_ticker
* Add more missing includes for us_ticker
* Fix mbed_hal_fpga_ci_test_shield/uart test
* Fix bare-metal build
* Fix Watchdog UNITTEST
* Fix Mbed OS 2 build for Public/Internal headers relocating
    @gpsimenos @evedon
    gpsimenos authored and evedon committed Aug 2, 2019
    Configuration menu
    Copy the full SHA
    3b23edb View commit details
    Browse the repository at this point in the history

  8. Address comments on workaround for Mbed OS 2 CI build after Public (#… 

    …11114)


* Modify compilation API to provide a list of paths to exclude from the build.
* `_exclude_files_from_build` becomes a static method
* Replace ternary expression with simple  `if/else` statement
* Make unit test case for dirs exclusion independent of system files
    @hugueskamba @evedon
    hugueskamba authored and evedon committed Aug 2, 2019
    Configuration menu
    Copy the full SHA
    2a9207b View commit details
    Browse the repository at this point in the history

  9. Upstream PR #11073 review request changes (#11135) 

    * Modify Doxygen grouping of `drivers` Public/Internal APIs
* Correct classification of `mbed_events.h`
* Amend name of Doxygen group containing Device Key API
* Classify `CallChain.h` as public API and relocate file
* Remove Doxygen group from `equeue_platform.h` as it has no Doxygen compliant documentation
* Move USB target specific code back to `usb/device/targets`
    @hugueskamba @evedon
    hugueskamba authored and evedon committed Aug 2, 2019
    Configuration menu
    Copy the full SHA
    f0f408b View commit details
    Browse the repository at this point in the history

  10. Mark Ethernet.h methods as Deprecated in Doxygen documentation (#11146)

    @hugueskamba @evedon
    hugueskamba authored and evedon committed Aug 2, 2019
    Configuration menu
    Copy the full SHA
    df85e8e View commit details
    Browse the repository at this point in the history