docs: drop the stray @param from the @returns lines in graham_scan_functions

[darkdi]

Description of Change

Every @returns line in geometry/graham_scan_functions.hpp carries a stray @param:

 * @returns @param int distance between p1 and p2.

Doxygen reads that as a parameter named int, so the return value goes undocumented and a phantom parameter shows up in the generated page instead. Five occurrences, one per function in the file.

Two of them were also describing the wrong thing, and since I was editing the line anyway:

• distSq said "distance between p1 and p2" while both its @brief and its body return the square of the distance.
• compare said "distance between p1 and p2" too — copied from distSq. It is the qsort comparator and returns -1 or 1.

Also fixed "Conver Hull" to "convex hull" on the last one.

Comments only; no code touched, and the file stays inside one directory.

Checklist

• Added description of change
• 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: comment-only change to one file, no behaviour or test impact.

[github-actions]

This pull request has been automatically marked as abandoned because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[darkdi]

Still current. The macOS job dies in ciphers/hill_cipher.cpp, which this PR does not touch, and geometry/graham_scan_functions.hpp has not changed since 2024, so the approval still applies as is.

[darkdi]

There is also a separate infrastructure failure in the approved-label job: it logs "Approval requirement is met, adding label" and then fails with "Resource not accessible by integration". Could a maintainer apply the approved label? The macOS failure mentioned above is in hill_cipher.cpp, outside this documentation change.

[realstealthninja]

Sorry for taking a while to respond, I have fixed the CI issues and have added an approved label and will be merging this as soon as the workflows finish.

Thank you for your contributions!

[realstealthninja]

Hmm, the file isn't currently showing up on Doxygen, might be due to the java doc style comments. Still merging, I'll raise an issue if youre interested.

[darkdi]

Yes, interested. I checked this with Doxygen: the header uses /****... banners, but doc/Doxyfile has JAVADOC_BANNER = NO, so the descriptions are ignored. Changing those openings to /** restores the file description and all five function docblocks without changing the global config. Please link the issue here when you open it.

[realstealthninja]

Yes, interested. I checked this with Doxygen: the header uses /****... banners, but doc/Doxyfile has JAVADOC_BANNER = NO, so the descriptions are ignored. Changing those openings to /** restores the file description and all five function docblocks without changing the global config. Please link the issue here when you open it.

#3234 to close the issue all the files will have to be corrected. Feel free to raise sub issues for each file to track progress or raise prs directly.