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

Discuss length of class desciptions for Doxygen comments #52

Open
nwolek opened this issue Oct 7, 2015 · 1 comment
Open

Discuss length of class desciptions for Doxygen comments #52

nwolek opened this issue Oct 7, 2015 · 1 comment
Labels

Comments

@nwolek
Copy link
Member

nwolek commented Oct 7, 2015

@tap added several comments back into the LowpassFourPole file here:
2366d06

My initial goal was to provide "just enough" useful information for that side panel in Xcode. The comments in a few places are now so long that they require quite a bit of scrolling and I find the information to be too much. I don't dispute that more information is good to document, but I don't think these class descriptions are the right place for it.

How long do we want these class descriptions to be? If we make them shorter, where should the additional information go?

@nwolek nwolek added the question label Oct 7, 2015
@tap
Copy link
Member

tap commented Oct 7, 2015

It might be useful to see how this is handled in other software codebases. Or it might not be useful.

One aspect of the header-only approach we are using that I find very compelling is that we have a single authoritative place for all knowledge about a specific implementation. It's like being DRY but at more of a "meta" level.

To that end, I feel that it is very desirable to have this type of information in this file -- keeping the documentation local to the implementation. Perhaps there are ways within that could ease the burden of information overload. I'm not sure if/how Xcode handles Doxygen "discussion" tags (or whatever they're called). Etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants