Skip to content

Fixed doxygen parameters names#3175

Merged
WardBrian merged 1 commit into
stan-dev:developfrom
tesseract241:develop
Apr 18, 2025
Merged

Fixed doxygen parameters names#3175
WardBrian merged 1 commit into
stan-dev:developfrom
tesseract241:develop

Conversation

@tesseract241
Copy link
Copy Markdown

Summary

Fixes the current codebase failing Doxygen generation due to function parameter names and Doxygen parameter names being different.

Tests

None.

Side Effects

None.

Release notes

Doxygen docs will be correctly generated.

Checklist

  • Copyright holder: myself, tesseract241

    The copyright holder is typically you or your assignee, such as a university or company. By submitting this pull request, the copyright holder is agreeing to the license the submitted work under the following licenses:
    - Code: BSD 3-clause (https://opensource.org/licenses/BSD-3-Clause)
    - Documentation: CC-BY 4.0 (https://creativecommons.org/licenses/by/4.0/)

  • the basic tests are passing
    For completeness I did run all the listed tests, they passed.

    • unit tests pass (to run, use: ./runTests.py test/unit)
    • header checks pass, (make test-headers)
    • dependencies checks pass, (make test-math-dependencies)
    • docs build, (make doxygen)
    • code passes the built in C++ standards checks (make cpplint)
  • the code is written in idiomatic C++ and changes are documented in the doxygen
    No code was changed, only comments.

  • the new changes are tested
    No code was changed, only comments.

@tesseract241 tesseract241 mentioned this pull request Apr 17, 2025
@WardBrian WardBrian linked an issue Apr 17, 2025 that may be closed by this pull request
Copy link
Copy Markdown
Member

@WardBrian WardBrian left a comment

Choose a reason for hiding this comment

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

Thanks!

@WardBrian WardBrian merged commit 50f1313 into stan-dev:develop Apr 18, 2025
22 of 24 checks passed
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.

Doxygen fails

3 participants