Merged
Conversation
Generated Doxygen documentation (v1.9.8) and performed comprehensive analysis of all 110 warning messages emitted during generation. Created two analysis files: - doxygen_warnings_summary.md: Categorized summary of all warnings with recommendations prioritized by impact - warnings_only.txt: Raw list of all warning messages for reference Warning categories identified: - 9 broken cross-references (unresolved \ref and \link commands) - 4 incorrect parameter documentation (outdated @param tags) - 97 undocumented members (primarily in ar.hpp iterator classes)
Resolved broken cross-references and parameter documentation mismatches: - Fixed unresolved \ref to 'BurgAlgorithm' in collomb2009.cpp by referencing ar::Burg class instead - Fixed unresolved \ref to 'faber1986' in faber1986.cpp by using plain function name reference - Escaped # character in ar.hpp documentation to prevent Doxygen from interpreting #define as a link command (5 occurrences) - Reorganized burg_method() documentation: moved comprehensive docs to the simpler overload (without working storage parameters) and used \copydoc on the complex overload to reference it, documenting only the additional f, b, Ak, ac parameters. This eliminates duplication and resolves parameter mismatch warnings. Removed temporary analysis files from earlier documentation generation. This addresses 13 of 110 Doxygen warnings (9 broken references + 4 parameter mismatches).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.