docs: clear remaining Doxygen warnings#90
Merged
Conversation
Add the missing @param entry for the mesh argument of the explicit-pin-indices overload of AngleBasedLSCM::Compute() so Doxygen no longer warns about an undocumented parameter. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
- Replace broken @copydoc target on the initializer_list overload of insert_vertices() with an inline brief. - Add /// docs for the non-const operator*() overloads and the FaceVecIter typedef of WheelIterator/EdgesIterator. - Wrap private members of WheelIterator/EdgesIterator and the detail::Range / detail::FilteringIterator scratch fields in \cond INTERNAL / \endcond so Doxygen skips genuinely internal implementation details. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
- Add one-line briefs for the Quadric +=/+ operators and the private ComputeImpl, levelRatio_, and minCoarseVertices_ members of HierarchicalLSCM. - Wrap the private section of detail::hlscm::DecimationMesh (helper methods, flat-array state, and scratch buffers) in \cond INTERNAL / \endcond so Doxygen skips the internal members of this internal helper class. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Re-run thirdparty/amalgamate/amalgamate.py after the documentation fixes to the multi-header sources. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
The previous commits used \cond INTERNAL to hide scratch members, iterator state, and the entire DecimationMesh private section from Doxygen output. That reintroduces a "concept of internal docs" via a different mechanism — which the project deliberately does not want. The detail:: namespace is the only signaling convention; for private members of public classes, brief inline docs are the consistent answer. Replace each \cond INTERNAL block with one-line documentation for the members it was hiding (advance helpers, iterator position state, DecimationMesh flat-array fields, scratch buffers). Docs remain at zero warnings. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
1 participant
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.
Summary
Clears all 58 pre-existing Doxygen warnings (58 → 0) in the public headers, with no API changes.
Categories addressed
@copydoctarget inHalfEdgeMesh::insert_vertices(initializer_list overload): replaced with an inline brief.@param meshonAngleBasedLSCM::Compute(mesh, pin0Idx, pin1Idx): added.HalfEdgeMesh::WheelIterator/EdgesIterator: documented all members inline (operator*overloads,FaceVecItertypedef, iterator state,advance_*helpers).detail::Range/detail::FilteringIterator: documented all members inline (range endpoints, iterator typedefs, predicate state, advance helper).detail::hlscm::Quadricoperators (+=,friend +): brief one-liners.detail::hlscm::DecimationMesh: documented every member of the private section (helper methods, flat-array state, scratch buffers).HierarchicalLSCMprivateComputeImpl,levelRatio_,minCoarseVertices_: brief one-liners.Conventions
@internaltags reintroduced (PR refactor(A8): extract shared LSCM system-building utility #88 removed those project-wide).\cond INTERNALblocks. The project deliberately doesn't surface a "concept of internal docs" — thedetail::namespace is the only API-stability signal, and for private members of public classes the consistent answer is brief inline docs rather than hiding them.EXTRACT_PRIVATE = YESandINTERNAL_DOCS = NOare unchanged.single_include/OpenABF/OpenABF.hppregenerated via the amalgamation script.Test plan
cmake --build /tmp/openabf-doxy --target docs— 58 warnings → 0cmake --build build_claudesucceeds in multi-header modectest --output-on-failure -j 4— 6/6 tests pass (includesOpenABF_TestParameterization)git clang-formatclean on all touched headerssingle_include/OpenABF/OpenABF.hppregenerated and included🤖 Generated with Claude Code