Various doc improvements

[Peter Kovacs]

[259f61026d81] contains various doc improvements:

• Rename all the ugly template parameters (too long and/or starting with an underscore).
• Rename function parameters starting with an underscore.
• Extend the doc for many classes.
• Use LaTeX-style O(...) expressions everywhere.
• A lot of small unification changes.
• Small fixes.
• Some other improvements.

[Alpar Juttner]

Replying to kpeter:

[259f61026d81] contains various doc improvements:

I like most of the changes, but

• Use LaTeX-style O(...) expressions everywhere.

I'm not 100% sure if it is a good idea.

Firstly, it slows down the doc generation. Secondly, LaTeX expressions have a major drawback that they do not (always) scale with the surrounding text when zooming. Sometimes, the expressions differ in size from the text even using the default browser settings.

Thus I prefer to keep the simple text for easy expressions like O(n), or O(n^{2), even if - in theory - the LaTeX expressions render much better.}

[Alpar Juttner]

Very good. Trac understand superscripts. So mu last sentence above should read as

Thus I prefer to keep the simple text for easy expressions like O(n), or O(n^2), even if - in theory - the LaTeX expressions render much better.

Btw can't doxygen generate subscripts/superscripts?

[Peter Kovacs]

Replying to alpar:

Thus I prefer to keep the simple text for easy expressions like O(n), or O(n^2), even if - in theory - the LaTeX expressions render much better.

I attached the modified changeset [c5fd2d996909].

Btw can't doxygen generate subscripts/superscripts?

It can, since it supports ^,, _, html tags.

[Alpar Juttner]

Replying to kpeter:

I attached the modified changeset [c5fd2d996909].

It went to the main.