-
Notifications
You must be signed in to change notification settings - Fork 119
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
Feature search doc #328
base: develop
Are you sure you want to change the base?
Feature search doc #328
Conversation
Thanks; for the spheres example the reader might get the impression that there would be no 3D version. Can we reformulate in a way that it becomes very clear from the beginning that both 2D and 3D are equally available, and that we just document the 2D version here for convenience? (This is a general remark that applies to all our examples.) |
That's a good point. I've added references to the 3D counterparts in the 2D examples. |
@@ -130,7 +130,8 @@ | |||
|
|||
/** \example particles/particles2.c | |||
* | |||
* 2D version of a generic particle tracking demo. | |||
* 2D version of a generic particle tracking demo (3D counterpart: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The first line shows up as a short title in the list on the web page. The information in parentheses is well meant, but maybe rather put into the text, not the first line, instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I looked at the html output for the default doxygen configuration and it seems that the short title is added only for documentation pages in the "Related Pages" section, while the "Examples" section just gives a list of the example file names without any additional description.
Doxygen documentation page for the search routines
This PR adds
search.dox
, a documentation page for the search routines. It contains an overview and describes local and partition search in detail as well as the user-defined query points. To reference it as an example, we add documentation ofexample/spheres
as well.