Thanks to visit codestin.com
Credit goes to github.com

Skip to content

doc: disable inheritance graphs #25542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
May 6, 2024
Merged

doc: disable inheritance graphs #25542

merged 2 commits into from
May 6, 2024

Conversation

@mshabunin
Copy link
Contributor

@mshabunin mshabunin commented May 3, 2024 •
edited
Loading

Resolves #25481

Some clas inheritance graphs are too big, so I decided to turn them off completely. Graphs for selected classes can be enabled using inheritancegraph command (https://www.doxygen.nl/manual/commands.html#cmdinheritancegraph).

I noticed that some collaboration diagrams can be quite large as well (see second diagram here: https://docs.opencv.org/4.x/d3/d63/classcv_1_1Mat.html), so we might need to disable them too (COLLABORATION_GRAPH option).

Extra change was needed to fix Javadoc documentation generation (version 17), for some reason two examples caused build issues.

@opencv-alalek opencv-alalek added the category: documentation Documentation fix or update label May 4, 2024
@opencv-alalek opencv-alalek added this to the 4.10.0 milestone May 4, 2024
@asmorkalov asmorkalov self-assigned this May 6, 2024
@asmorkalov
Copy link
Contributor

asmorkalov commented May 6, 2024

The patch has not disabled inheritance graphs. See https://pullrequest.opencv.org/buildbot/export/pr/25542/docs/d9/dba/classcv_1_1StereoBM.html as example.

@asmorkalov asmorkalov self-requested a review May 6, 2024 06:29
@mshabunin
Copy link
Contributor Author

mshabunin commented May 6, 2024 •
edited
Loading

@asmorkalov , it is not "inheritance graph", it is "collaboration diagram" 🙂 Currently both are enabled, this PR disables only "inheritance graph". We can disable "collaboration diagram" too (COLLABORATION_GRAPH option). Do you think we should disable it?

Current version with both graphs: https://docs.opencv.org/4.x/d9/dba/classcv_1_1StereoBM.html

Difference:

If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will generate a graph for each documented class showing the direct and indirect inheritance relations.

If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a graph for each documented class showing the direct and indirect implementation dependencies (inheritance, containment, and class references variables) of the class with other documented classes.

asmorkalov
asmorkalov approved these changes May 6, 2024
View reviewed changes
Copy link
Contributor

@asmorkalov asmorkalov left a comment

Choose a reason for hiding this comment

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

👍

@asmorkalov asmorkalov merged commit 26a5730 into opencv:4.x May 6, 2024
@mshabunin mshabunin deleted the fix-disable-diagram branch May 6, 2024 09:13
@mshabunin mshabunin mentioned this pull request Jun 14, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@asmorkalov asmorkalov asmorkalov approved these changes

Assignees

@asmorkalov asmorkalov

Labels

category: documentation Documentation fix or update

Projects

None yet

Milestone

4.10.0

Development

Successfully merging this pull request may close these issues.

Flowchart of class template does not properly horizontally scale

3 participants

@mshabunin @asmorkalov @opencv-alalek