Add Doxygen documentation across traincascade and refresh project READMEs#29
Merged
Conversation
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
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
Documents the cascade-trainer library, the traincascade CLI entry point and the test suite with Doxygen-style comments, and rewrites the two top-level README files so the repository structure and build flow are discoverable. No functional code changes — only comments and Markdown.
Motivation
The traincascade sources were largely undocumented and the project README contained only a one-line description. New contributors had to read the OpenCV legacy ML hierarchy (
CvStatModel→CvDTree/CvBoost→ cascade subclasses) end-to-end to understand the layout. This MR adds inline API documentation and a high-level map so the codebase is self-describing.Changes
Doxygen comments — public headers (include)
@filebriefs on all 20 headers.CvCascadeParams,CvCascadeBoostParams,CvDTreeParams,CvBoostParams,CvHaarFeatureParams,CvLBPFeatureParams,CvHOGFeatureParams.@brief/@param/@returnon the main entry points:CvCascadeClassifier::train, theCvFeatureEvaluatorinterface,CvDTree'strain/predict/find_split_*/prune_cv,CvBoost/CvCascadeBoost/CvCascadeBoostTree, and theCvDTreeTrainData/CvCascadeBoostTrainDatasetup helpers.CC_*XML tag macros and theCV_SUM_OFFSETS/CV_TILTED_OFFSETSintegral-image helpers.Doxygen comments — driver
@fileblock,@briefonmain(), and per-variable doc comments explaining the parameter structs and the argument-parsing fallthrough intoscanAttr().Markdown
test_*.cppto the component it exercises, plus CTest run instructions and a pointer to the coverage build.Intentionally not modified
OpenCV-licensed verbatim sources keep their original Intel / OpenCV Foundation headers untouched:
traincascade/lib/src/o_*.cppValidation
cmake --build build --target traincascade→[10/10] Linking CXX executable traincascade/traincascade, clean.Checklist