jessevdk / cldoc

clang based documentation generator for C and C++
GNU General Public License v2.0
552 stars 58 forks source link

cldoc odd behavior #98

Open rhl- opened 9 years ago

rhl- commented 9 years ago

screen shot 2015-04-20 at 7 13 47 pm screen shot 2015-04-20 at 7 13 32 pm

In the typedefs section the red 'type' is a bit misplaced. Also, the bit to the right explaining what the typedef is, is incorrect. A layout similar to: http://en.cppreference.com/w/cpp/container/vector is preferable.

Then in the functions, the return types need not be translated at all. Since we are presenting the typedefs, they should be well defined tokens. e.g. iterator not Abstract_simplex< T>::iterator for the begin() function. Also note the odd formatting of the () in the begin function.

jessevdk commented 9 years ago

The type thing would be easy to change, but avoiding the explode of the template arguments is actually not currently possible in a reliable way due to how clang doesn't provide this information. I agree this is pretty ugly and not helpful. I'd be glad to hear about a solution to this issue.