Docs/andrembcosta/pf fracture

[andrembcosta]

Opened this new PR to add the documentation of the phase-field classes, as the old PR became too old and merging develop led to lots of conflicts.

Although I added the function and classes descriptions following https://geosx-geosx.readthedocs-hosted.com/en/latest/docs/sphinx/developerGuide/Contributing/Doxygen.html, when I compile the doxygen docs with make geosx_doxygen, I still dont the stuff I have added. Any ideas of what could be missing?

[jhuang2601]

Have you run make uncrustify_style to check and update code format?

[andrembcosta]

Have you run make uncrustify_style to check and update code format?

just did it, thanks for the reminder Jian!

[CusiniM]

Opened this new PR to add the documentation of the phase-field classes, as the old PR became too old and merging develop led to lots of conflicts.

Although I added the function and classes descriptions following https://geosx-geosx.readthedocs-hosted.com/en/latest/docs/sphinx/developerGuide/Contributing/Doxygen.html, when I compile the doxygen docs with make geosx_doxygen, I still dont the stuff I have added. Any ideas of what could be missing?

Which things are you not seeing? I don't think we build the doxygen for all geosx modules.

[CusiniM]

Actually, everything you have added seems to be in namespaces for which we don't build the doxygen: https://geosx-geosx.readthedocs-hosted.com/en/latest/doxygen_output/html/namespaces.html

[andrembcosta]

Opened this new PR to add the documentation of the phase-field classes, as the old PR became too old and merging develop led to lots of conflicts. Although I added the function and classes descriptions following https://geosx-geosx.readthedocs-hosted.com/en/latest/docs/sphinx/developerGuide/Contributing/Doxygen.html, when I compile the doxygen docs with make geosx_doxygen, I still dont the stuff I have added. Any ideas of what could be missing?

Which things are you not seeing? I don't think we build the doxygen for all geosx modules.

I thought I would see something about the PhaseFieldSolver here:

[CusiniM]

I would say that we are not building the doxygen for physicsSolvers. I thought we were building it for constitutive but it looks like we are not.

[andrembcosta]

I would say that we are not building the doxygen for physicsSolvers. I thought we were building it for constitutive but it looks like we are not.

All the phase-field fracture classes are either physicsSolvers or constitutive, so, it is probably ok then?