This is an archive of the discontinued LLVM Phabricator instance.

[docs] Hide collaboration and include graphs in doxygen docs
ClosedPublic

Authored by tbaeder on May 2 2023, 3:11 AM.

Details

Summary

I think they are pretty useless and make the docs harder to read.

Set the COLLABORATION_GRAPH, INCLUDE_GRAPH and INCLUDED_BY_GRAPH variables all to NO.

The changes are similar to the ones done in https://github.com/googleapis/google-cloud-cpp/pull/397, but I did not remove the class graph, I think that one is actually helpful.

Not sure who to add as reviewers (none of the codeowners files seem to mention a owner for docs...), so adding some frontend people.

Diff Detail

Event Timeline

tbaeder created this revision.May 2 2023, 3:11 AM
Herald added a reviewer: rafauler. · View Herald Transcript
Herald added a reviewer: Amir. · View Herald Transcript
Herald added a reviewer: maksfb. · View Herald Transcript
Herald added projects: Restricted Project, Restricted Project. · View Herald Transcript
tbaeder requested review of this revision.May 2 2023, 3:11 AM
Herald added projects: Restricted Project, Restricted Project, Restricted Project, Restricted Project, Restricted Project, Restricted Project. · View Herald TranscriptMay 2 2023, 3:11 AM

I think this is a reasonable change -- I don't see a whole lot of value out from the include or collaboration graphs, so unless someone has strong opinions otherwise, I think this LG for the Clang side of things.

Looks good on the OpenMP side as we don’t generally have a good API doc anyway.

nikic accepted this revision.May 4 2023, 1:16 AM
nikic added a subscriber: nikic.

LGTM, only the inheritance graph is useful, which this preserves if I understand correctly (CLASS_GRAPH is still YES).

This revision is now accepted and ready to land.May 4 2023, 1:16 AM
kwk accepted this revision.May 4 2023, 2:36 AM
kwk added a subscriber: kwk.

LGTM

This revision was landed with ongoing or failed builds.May 4 2023, 3:28 AM
This revision was automatically updated to reflect the committed changes.