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

doxygen fix #73

Merged
merged 1 commit into from
Nov 13, 2020
Merged

doxygen fix #73

merged 1 commit into from
Nov 13, 2020

Conversation

edwardhartnett
Copy link
Contributor

Part of #15

Convert one function to explore use of brief tag. It's needed at the file level, but not at the subroutine level.

@edwardhartnett
Copy link
Contributor Author

With this, I see the description in the file list:

image

@edwardhartnett
Copy link
Contributor Author

One problem (?) is that a separate brief tag is needed for file and subprogram. Normally this makes sense because one file holds multiple subprograms. So the file level one summarizes what's in the file, and each subprogram summarizes what's in the subprogram.

But in this case there is one subprogram per file...

@jbathegit
Copy link
Collaborator

Yeah, I thought about that too, but what I'm going to do for this is to have a slightly more general description at the file level vs. at the subprogram level, the idea being that when everything's displayed in "Files" we want the user to be able to quickly determine where they need to drill down to find what they're looking for. Hopefully you'll see what I mean when I submit my next PR ;-)

@jbathegit jbathegit merged commit 54ee169 into develop Nov 13, 2020
@jbathegit jbathegit deleted the ejh_dox branch November 13, 2020 21:04
@jbathegit
Copy link
Collaborator

Thanks for playing around with this to help figure this out!

@edwardhartnett
Copy link
Contributor Author

I do agree that the list of files looks much nicer and more useful when each file has a brief description next to it.

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.

None yet

2 participants