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.

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

Update doxyfile for doxygen 1.9.2 #148

Merged
merged 4 commits into from
Aug 24, 2021

Conversation

muneebahmed10
Copy link
Contributor

@muneebahmed10 muneebahmed10 commented Jan 11, 2021

Description:
doxygen 1.9.2 deprecates the following tags, resulting in warnings:

  • 'OUTPUT_TEXT_DIRECTION'
  • 'COLS_IN_ALPHA_INDEX'
  • 'LATEX_SOURCE_CODE'
  • 'RTF_SOURCE_CODE'
  • 'DOCBOOK_PROGRAMLISTING'

The first two commits update the file manually to allow it to work with both 1.8.20 and 1.9.2 without warnings. The last commit updates the file with doxygen -u, but it will only work with 1.9.2. I don't think there's any value in keeping compatibility with 1.8.20, so I think it's better to just use doxygen -u.

@muneebahmed10 muneebahmed10 marked this pull request as draft January 12, 2021 00:16
@muneebahmed10 muneebahmed10 changed the title Update doxyfile for doxygen 1.9.1 Update doxyfile for doxygen 1.9.2 Aug 21, 2021
@muneebahmed10 muneebahmed10 marked this pull request as ready for review August 21, 2021 17:52
# The default value is: MathJax_2.
# This tag requires that the tag USE_MATHJAX is set to YES.

MATHJAX_VERSION = MathJax_2
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As USE_MATHJAX is set to NO, should this be set to an empty value to avoid giving misrepresentation of MathJax being used in the doxygen generation?

# The default value is: NO.
# This tag requires that the tag UML_LOOK is set to YES.

DOT_UML_DETAILS = NO
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the description for this config seems relevant to OOP languages, should this be set to NONE for our libraries?

@muneebahmed10
Copy link
Contributor Author

The changes to these files were done by doxygen -u. If we make additional changes here we should propagate them to all the other repos

@archigup archigup merged commit 73eee0b into FreeRTOS:main Aug 24, 2021
@muneebahmed10 muneebahmed10 deleted the update-doxygen branch August 24, 2021 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants