search

idaholab / moose

Multiphysics Object Oriented Simulation Environment
https://www.mooseframework.org
GNU Lesser General Public License v2.1
1.76k stars 1.05k forks source link

Incomplete inheritance chains on the online Doxygen docs #5824

Open dschwen opened 9 years ago

dschwen commented 9 years ago

Compare the inheritance graph on

http://mooseframework.org/docs/doxygen/modules/classSplitCHParsed.html

with this graph I generated locally (using Doxygen 1.8.10)

classsplitchparsed__inherit__graph

aeslaughter commented 9 years ago

I believe this was intentional, we don't include moose/framework in the modules documentation. Just like we don't include libMesh in the MOOSE doxygen. Perhaps we need more targets.

On Thu, Oct 15, 2015 at 2:32 PM, Daniel Schwen notifications@github.com wrote:

Compare the inheritance graph on

http://mooseframework.org/docs/doxygen/modules/classSplitCHParsed.html

with this graph I generated locally (using Doxygen 1.8.10)

[image: classsplitchparsedinheritgraph] https://cloud.githubusercontent.com/assets/202302/10526689/f248db56-7351-11e5-99f0-89dd772bddc6.png

— Reply to this email directly or view it on GitHub https://github.com/idaholab/moose/issues/5824.

dschwen commented 9 years ago

SplitCHBase is in the Phase field module. It should show up at least to that class.

friedmud commented 9 years ago

I don't remember this being intentional... but I could be misremembering. I would vote for Modules including MOOSE... otherwise you may not even know what type of object an class is...

On Thu, Oct 15, 2015 at 8:11 PM Daniel Schwen notifications@github.com wrote:

SplitCHBase is in the Phase field module. It should show up at least to that class.

— Reply to this email directly or view it on GitHub https://github.com/idaholab/moose/issues/5824#issuecomment-148558434.

dschwen commented 9 years ago

To reiterate, even ignoring framework the current inheritance diagram is incomplete. The example is missing SplitCHCRes and SplitCHBase. Updating from Doxygen 1.8.6 to 1.8.10 may already fix this issue!

dschwen commented 9 years ago

Ping @milljm, can you help with that?

moosebuild commented 9 years ago

I tried running doxygen 1.8.10 in the modules directory and got the same shortened inheritance graph. This is probably due to DerivativeMaterialInterface being in framework so doxygen doesn't know about it. Combining the doxygen INPUT to both framework and modules gives a nice graph like yours though.

dschwen commented 7 years ago

It would definitely be nice to get this fixed.