Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] doxy2swig based ForTrilinos documentation generation for Tpetra and Teuchos #126

Closed
wants to merge 1 commit into from

Conversation

mattbement
Copy link

No description provided.

@mattbement
Copy link
Author

Updated some of the python scripts to those used in 12-12-branch, rather than 12-12-1, as they handle python 2/3 issues.

@codecov-io
Copy link

codecov-io commented Dec 1, 2017

Codecov Report

❗ No coverage uploaded for pull request base (master@7cd016a). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #126   +/-   ##
=========================================
  Coverage          ?   41.19%           
=========================================
  Files             ?       32           
  Lines             ?    13146           
  Branches          ?        0           
=========================================
  Hits              ?     5416           
  Misses            ?     7730           
  Partials          ?        0

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7cd016a...8d5c5c5. Read the comment docs.

@aprokop
Copy link
Collaborator

aprokop commented Dec 2, 2017

@mattbement I updated the PR:

  • Proper license on files
  • More appropriate CMake logic

We cannot merge this PR until we full test it. This depends on swig-fortran/swig#46.

In the short term, we can clean up this PR (squash/rebase).

@aprokop aprokop changed the title doxy2swig based ForTrilinos documentation generation for Tpetra and Teuchos [WIP] doxy2swig based ForTrilinos documentation generation for Tpetra and Teuchos Dec 2, 2017
@aprokop aprokop mentioned this pull request Dec 4, 2017
7 tasks
@aprokop
Copy link
Collaborator

aprokop commented Dec 13, 2017

Per @mattbement:

A quick note about the documentation...As you probably saw, Seth added the docstring output to swig. However, doxygen's support for fortran leaves something to be desired. It want types (which have previously been declared public) to have an additional public decorator in their description for it to pick up the documentation. Since, swig is emitting valid fortran, Seth and both think that adding superfluous decorators is probably not the right thing. I will spend a little time looking into what it would take to fix doxygen (or at least just submit a bug report).

It looks like this was reported over 4 years ago. https://bugzilla.gnome.org/show_bug.cgi?id=706864

@aprokop aprokop requested review from tjfulle and removed request for tjfulle December 13, 2017 15:17
@aprokop aprokop changed the base branch from develop to master June 7, 2018 15:01
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants