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

Add missing parts of doxygen generated documentation #229

Closed
wants to merge 1 commit into from

Conversation

nilason
Copy link
Contributor

@nilason nilason commented Sep 25, 2019

A lot of the nicely documented code never get generated at all or poorly by doxygen. The reason is primarily missing descriptions of namespaces, as well as some classes, but also by missing brief tags.

This PR addresses this issue in two commits. Unfortunately, I could't come up with a better approach for adding namespace description than adding package/namespace header files (in the same pattern as for other similar cases, e.g. geos/geosAlgorithm.h).

@dbaston
Copy link
Member

dbaston commented Oct 15, 2019

Introducing new header files to document the namespaces seems a bit overkill, but fixing all of the \brief stuff is a nice improvement.

@nilason
Copy link
Contributor Author

nilason commented Oct 17, 2019

A closer look at the existing namespace header files, reveals that their present use is in fact mainly for documentation, with a few exceptions (some are for example included in XMLTester.cpp).
My guess is that somewhere on the road it was decided to include only what is needed, if they ever were used for bunch-include in a more general way.
As I see it, either it may be accepted to add these five files, or I squeeze in the namespace docs in a random file where it is declared.
Alternatively, ALL more-or-less unused namespace files may be baked into one file, for instance geos/geom.h. The latter is beyond the scope of this PR though.

@dbaston
Copy link
Member

dbaston commented Oct 17, 2019

Alternatively, ALL more-or-less unused namespace files may be baked into one file, for instance geos/geom.h. The latter is beyond the scope of this PR though.

This strikes me as the cleanest solution (maybe just have a namespaces.h). The namespace files could then be removed. No worries if you don't want to tackle it, though.

@nilason
Copy link
Contributor Author

nilason commented Oct 17, 2019

Sounds good to me, dropped the commit with the added files. May be merged, if you will.

I can have a go for it, dropping the namespace files (at least see what it leads to), I'll put up a new PR. That is, if you're not eager for doing it yourself.

@dbaston
Copy link
Member

dbaston commented Oct 18, 2019

ok, done with a446583. Thanks!

@dbaston dbaston closed this Oct 18, 2019
@nilason nilason deleted the docs-add-missing branch November 11, 2019 07:03
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