Document metric classes

[jerryct]

No description provided.

[bdangit]

Long live Doxygen!

[jerryct]

Or clang-doc (https://clang.llvm.org/extra/clang-doc.html) - at one point in time.

[gjasny]

please rebase to fix TravisCI

[jerryct]

I rebased it.

[gjasny]

Is there a reason behind removing the argument names?

[jerryct]

It is the style currently used in many places of the library in the header file. Personally I would add the argument names also in the header (it also eases documenting with doxygen). I reverted the changes made to the argument names.

[gjasny]

Do you have an idea where we could publish the generated doxygen files easily? I played around with "Read The Docs" here and Breathe / Sphinx, but it does not look promising. Uploading to github pages might also be an option, but maybe you know something easier to set up?

[gjasny]

Could you please rebase?

[jerryct]

I rebased it.

[jerryct]

Regarding documentation I have no better idea. I think github pages is the most straightforward way. Travis simply generates the html and uploads it to a special branch. There are some examples:

https://gist.github.com/francesco-romano/351a6ae457860c14ee7e907f2b0fc1a5

We need to pimp it a little bit further:

• don't generate private/protected members
• exclude namespace detail with a doxygen annotation
• remove these file, dir and namespace stuff

So I would still give it a try.

[jerryct]

I think the easiest way to get the documentation is GitHub pages. We could simply create a new repository and let travis push to it:

https://github.com/jerryct/doc_test
https://jerryct.github.io/doc_test/index.html
https://jerryct.github.io/doc_test/annotated.html

The doxygen config is this:
2c476f1