Skip to content

Update doxygens to be in sync #8424

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.

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

Merged
merged 1 commit into from
Oct 18, 2018
Merged

Conversation

c1728p9
Copy link
Contributor

@c1728p9 c1728p9 commented Oct 14, 2018

Description

Make the following changes to doxyfile_options:

  • Change CASE_SENSE_NAMES so names of files generated match mbed-os docs
  • Change DISABLE_INDEX so navigation bar shows
  • Change CLASS_DIAGRAMS so inheritance diagram gets generated
  • Change USE_MDFILE_AS_MAINPAGE and add DOXYGEN_FRONTPAGE.md to FILE_PATTERNS so the correct main page is found and used
  • Remove DEVICE_ETH from PREDEFINED since this is no longer relevent
  • Change GENERATE_XML and XML_OUTPUT so no xml is generated
  • Change SEARCHENGINE to match the docs

Make the following changes in doxygen_options.json:

  • Add all non-default values in doxyfile_options to the json
  • Break json into 3 groups
    1. Values that are the same as doxyfile_options
    2. Values that must be different from doxyfile_options
    3. Values the are overriden by the docs builder
  • Make the doxyegn search directory "INPUT" start in mbed-os rather than one level above mbed-os.

Finally, rename the BLE doxygen front page so it is not confused with the mbed-os front page.

Pull request type

[ ] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[x] Docs update
[ ] Test update
[ ] Breaking change

Make the following changes to doxyfile_options:
-Change CASE_SENSE_NAMES so names of files generated match mbed-os docs
-Change DISABLE_INDEX so navigation bar shows
-Change CLASS_DIAGRAMS so inheritance diagram gets generated
-Change USE_MDFILE_AS_MAINPAGE and add DOXYGEN_FRONTPAGE.md to
    FILE_PATTERNS so the correct main page is found and used
-Remove DEVICE_ETH from PREDEFINED since this is no longer relevent
-Change GENERATE_XML and XML_OUTPUT so no xml is generated
-Change SEARCHENGINE to match the docs

Make the following changes in doxygen_options.json:
-Add all non-default values in doxyfile_options to the json
-Break json into 3 groups
    1. Values that are the same as doxyfile_options
    2. Values that must be different from doxyfile_options
    3. Values the are overriden by the docs builder
-Make the doxyegn search directory "INPUT" start in mbed-os rather
    than one level above mbed-os.

Finally, rename the BLE doxygen front page so it is not confused with
the mbed-os front page.
@NirSonnenschein
Copy link
Contributor

/morph build

@mbed-ci
Copy link

mbed-ci commented Oct 18, 2018

Build : SUCCESS

Build number : 3396
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/8424/

Triggering tests

/morph test
/morph export-build
/morph mbed2-build

@mbed-ci
Copy link

mbed-ci commented Oct 18, 2018

@mbed-ci
Copy link

mbed-ci commented Oct 18, 2018

@cmonr cmonr merged commit f3fee04 into ARMmbed:master Oct 18, 2018
@cmonr cmonr removed the needs: CI label Oct 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants