Skip to content

Tempus: Fix Doxygen

James Willenbring requested to merge fix-tempus-doxygen into develop

Created by: jmgate

Description

Deal with a number of Tempus doxygen warnings:

  • Equation errors.
  • End of list marker without any list.
  • Disconnects between _decl and _impl files.
  • Etc.

@trilinos/tempus

Motivation and Context

Email from @ccober6:

Hi all,

I have doxygen warnings that I can not track down, and wondered if you had any thoughts. I get many of the following type warnings:

/Users/ccober/myOffice/Trilinos/packages/tempus/src/Thyra_AdjointLinearOpWithSolveFactory.hpp:88: warning: End of list marker found without any preceding list items

Here is what I know so far

  • They only occur in Thyra_* files (Thats why I am asking Eric about this.)
  • They occur on /** \brief . */
  • Adding a short text to the brief fixes it.
  • Removing the dot “.” fixes it.
  • A dot “.” ends the brief.

Is this "brief ." important?

Thanks,

Curt

How Has This Been Tested?

Tempus documentation builds without errors with doxygen-1.8.14. No code changes, so no need to run ctest.

Checklist

  • My commit messages mention the appropriate GitHub issue numbers.
  • My code follows the code style of the affected package(s).
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the code contribution guidelines for this project.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • No new compiler warnings were introduced.
  • These changes break backwards compatibility.

Merge request reports