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

More doxygen work #198

Merged
merged 2 commits into from
Oct 29, 2020
Merged

More doxygen work #198

merged 2 commits into from
Oct 29, 2020

Conversation

edwardhartnett
Copy link
Collaborator

Part of #191

More work on the doxygen documentation.

Copy link
Collaborator

@GeorgeGayno-NOAA GeorgeGayno-NOAA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks ok.

@edwardhartnett
Copy link
Collaborator Author

Are you looking at the output as well? You should do so, it is here: https://noaa-emc.github.io/UFS_UTILS/.

@GeorgeGayno-NOAA
Copy link
Collaborator

Are you looking at the output as well? You should do so, it is here: https://noaa-emc.github.io/UFS_UTILS/.

I see that more of the files are now 'clickable'. And the info in most of them looks ok. However, I tend to recycle module names. You will see multiple instances of 'driver.f90' and 'program_setup'. When I click on https://noaa-emc.github.io/UFS_UTILS/sfc__climo__gen_8fd_2program__setup_8f90.html Then click on the module program setup link (https://noaa-emc.github.io/UFS_UTILS/namespaceprogram__setup.html), it is pointing to the program-setup under chgres_cube, not sfc_climo_gen. So I think it is getting confused by the duplicate files names. I hope we don't have to rename all the modules with unique names.

@edwardhartnett
Copy link
Collaborator Author

We will not have to rename modules. Yes, there is some confusion about this in the output, but I'm sure we can straighten that out. I will do some browsing of on-line resources and see if I can figure it out.

But the files list is actually not the way most readers will interact with the docs. We will add a mainpage that will be more user-friendly face on the docs.

I will merge this PR and add something to the mainpage for the next round, so you can see what I mean...

@edwardhartnett edwardhartnett merged commit 12df3f4 into develop Oct 29, 2020
@edwardhartnett edwardhartnett deleted the ejh_docs_5 branch October 29, 2020 15:59
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.

2 participants