Want doxygen-like source code index

[eschnett]

I am currently using emacs's "grep-find" in the installed include/hpx to learn about HPX functions and classes and their signatures. It would be most convenient if there was a doxygen-like list that was automatically generated.

The kind of questions I am asking is:

• does get_gid() of a client return an id_type, or a reference to an id_type?
• is there a function "when" for futures that is similar to "wait", but returns the future instead of its content?

Such a list would simplify looking for the answers.

[hkaiser]

Eric, we tried to do that but ended up with a large unusable mess which contained all kind of information unrelated to the API or to things any user wanted to know about. The effort of cleaning this up was deemed to be much larger than to go the opposite way: adding things explicitly. We decided to manually add documentation about functions and data structures we know are exposed to the user. It's a slow process, but the result is much more satisfactory. So I'm going to close this ticket as 'won't fix'. However that does not mean we'll stop adding more information to the documentation. Your suggestion above a great (keep them coming), I'll make sure this information is available in the docs.