Skip to content

fix(docs): convert JAVADOC_BANNER comments to standard Doxygen style - #3237

Open
LearnCodeZaid wants to merge 1 commit into
TheAlgorithms:masterfrom
LearnCodeZaid:fix/doxygen-banner-3234
Open

LearnCodeZaid wants to merge 1 commit into
TheAlgorithms:masterfrom
LearnCodeZaid:fix/doxygen-banner-3234

Conversation

@LearnCodeZaid

Copy link
Copy Markdown

Fixes part of #3234.

Doxygen is configured with JAVADOC_BANNER = NO (doc/Doxyfile L228), so banner-style blocks starting with /**** are not parsed and render as bold/unviewable on https://thealgorithms.github.io/C-Plus-Plus/.

This PR converts those banner blocks to standard Doxygen Javadoc blocks (/** ... */) in 8 files. No code changes, syntax-checked with g++ -fsyntax-only.

Files:

  • sorting/selection_sort_iterative.cpp
  • search/binary_search.cpp (incl. one mid-function banner converted to plain /* */ since it is not a doc comment)
  • search/interpolation_search.cpp
  • dynamic_programming/partition_problem.cpp
  • geometry/graham_scan_algorithm.cpp
  • geometry/graham_scan_functions.hpp
  • data_structures/morrisinorder.cpp
  • numerical_methods/durand_kerner_roots.cpp

Converts banner-style comment blocks (/**** ... ****/) to standard
Doxygen Javadoc blocks (/** ... */) in 8 files so docs render on
https://thealgorithms.github.io/C-Plus-Plus/ instead of appearing bold
and unviewable. No code changes.

Files: selection_sort_iterative, binary_search, interpolation_search,
partition_problem, graham_scan_algorithm, graham_scan_functions,
morrisinorder, durand_kerner_roots.

Part of TheAlgorithms#3234
@realstealthninja

Copy link
Copy Markdown
Collaborator

Did you involve any LLM in the process of creating this pr?

@realstealthninja

realstealthninja commented Oct 1, 2026 •

Copy link
Copy Markdown
Collaborator

syntax-checked with g++ -fsyntax-only.

Why? You should try compiling with build docs enabled to see if it worked.

@realstealthninja realstealthninja added the question Further information is requested label Oct 3, 2026

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

question Further information is requested

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants