Skip to content
Permalink
Browse files

Do not create collaboration diagrams in doxygen docs

The diagrams do not really add much value and do not highlight the important concepts
of classes, confusing the user and making things looks more complicated than they are
  • Loading branch information
wonder-sk committed Sep 6, 2014
1 parent c454617 commit 8d598d4df1c7c960ef1091771f912352b1645b22
Showing with 1 addition and 1 deletion.
  1. +1 −1 cmake_templates/Doxyfile.in
@@ -1511,7 +1511,7 @@ CLASS_GRAPH = YES
# indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes.

COLLABORATION_GRAPH = YES
COLLABORATION_GRAPH = NO

# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for groups, showing the direct groups dependencies

10 comments on commit 8d598d4

@nyalldawson

This comment has been minimized.

Copy link
Collaborator

@nyalldawson nyalldawson replied Sep 7, 2014

@wonder-sk This was a great move. On the same topic, do you think we could remove the "References"/"Referenced by" sections from the API docs? IMO these clutter the api docs and again make the api seem MUCH more complicated than it is. They are only useful for QGIS devs (not plugin devs), and I suspect most devs would be using QtCreator or a similar IDE which would show this information anyway.

@nyalldawson

This comment has been minimized.

Copy link
Collaborator

@nyalldawson nyalldawson replied Sep 7, 2014

@wonder-sk ditto for private slots/private functions/private attributes...

@wonder-sk

This comment has been minimized.

Copy link
Member Author

@wonder-sk wonder-sk replied Sep 8, 2014

@nyalldawson Good idea, I'm removing those too...

@nyalldawson

This comment has been minimized.

Copy link
Collaborator

@nyalldawson nyalldawson replied Sep 8, 2014

@wonder-sk what about the "Definition at " - can we strip that too?

@wonder-sk

This comment has been minimized.

Copy link
Member Author

@wonder-sk wonder-sk replied Sep 8, 2014

@nyalldawson I think so - removed too. The docs look much better now!

@nyalldawson

This comment has been minimized.

Copy link
Collaborator

@nyalldawson nyalldawson replied Sep 8, 2014

@wonder-sk thanks! I totally agree... Simplifying the appearance of the docs is a huge step forward in usability.

@timlinux

This comment has been minimized.

Copy link
Member

@timlinux timlinux replied Sep 8, 2014

sniff - I actually like and use those diagrams a lot....

@timlinux

This comment has been minimized.

Copy link
Member

@timlinux timlinux replied Sep 8, 2014

(not saying you have to bring them back though because I am probably some sort of minority...)

@wonder-sk

This comment has been minimized.

Copy link
Member Author

@wonder-sk wonder-sk replied Sep 9, 2014

@timlinux Hm... Do you like inheritance [1] or collaboration [2] diagrams? Because I have removed just the latter ones which were in most cases producing images without much sense - like [2] for QgsVectorLayer

[1] http://qgis.org/api/2.0/classQgsVectorLayer__inherit__graph.png
[2] http://qgis.org/api/2.0/classQgsVectorLayer__coll__graph.png

@timlinux

This comment has been minimized.

Copy link
Member

@timlinux timlinux replied Sep 9, 2014

Yeah I kinda referred to them both a lot - but no worries I agree they probably get a bit overwhelming.

Please sign in to comment.
You can’t perform that action at this time.