Skip to content

docs: fix Doxygen banner comments in search algorithms (part of #3234) - #3250

Open
akhila-pynam wants to merge 2 commits into
TheAlgorithms:masterfrom
akhila-pynam:fix/doxygen-banner-search
Open

akhila-pynam wants to merge 2 commits into
TheAlgorithms:masterfrom
akhila-pynam:fix/doxygen-banner-search

Conversation

@akhila-pynam

@akhila-pynam akhila-pynam commented Oct 16, 2026 •

Copy link
Copy Markdown

Description of Change

Converts Javadoc-style banner comments (/****************) to standard Doxygen comments (/** ... */) in search/binary_search.cpp and search/interpolation_search.cpp.

In doc/Doxyfile, JAVADOC_BANNER = NO is configured, which causes Doxygen to treat banner-style comments as plain C comments and ignore them. As a result, the @file blocks are ignored and the files are rendered bold and unclickable on the GitHub Pages documentation site. Converting them to standard Doxygen comment blocks resolves this issue.

Related to #3234

Checklist

  • Added description of change
  • Added tests and example, test must pass
  • Added documentation so that the program is self-explanatory and educational - Doxygen guidelines
  • Relevant documentation/comments is changed or added
  • PR title follows semantic commit guidelines
  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • I acknowledge that all my contributions will be made under the project's license.

Notes: Fixes Doxygen rendering for search/binary_search.cpp and search/interpolation_search.cpp by replacing Javadoc banner style comments with standard Doxygen comments.

This branch has not been deployed

No deployments
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.

1 participant