libgit2 / docurium

Doxygen replacement for the libgit2 project
http://libgit2.github.com/libgit2
MIT License
158 stars 25 forks source link

Function calls with underscores are rendered underlined #2

Closed carlosmn closed 13 years ago

carlosmn commented 13 years ago

As can be seen in http://libgit2.github.com/libgit2/ex/HEAD/general.html the function calls that contain an underscore are rendered underlined, which is quite distracting.

vmg commented 13 years ago

...They are linked to the actual API documentation for that function. What's wrong with that? :p

carlosmn commented 13 years ago

They're not clearly highlighted as links, so it just looks (to me, at least) like they were wrongly rendered. So they should either be marked more clearly or the underline taken away.

I never knew they were links.

vmg commented 13 years ago

Open a PR that fixes the CSS then... I can't really think of a more obvious way to mark a link than to underline it. :)

carlosmn commented 13 years ago

Open a PR that fixes the CSS then...

Lazy open source developers... :p

I can't really think of a more obvious way to mark a link than to underline it. :)

Colours come to mind. If the colour is indistinguishable from normal text, I assume it's just underlined text, but maybe I'm just not a web person. Alternatively, leaving the link unmarked until you hover over it, and have some sort of header (which we should probably have anyway) saying that you can click on the functions to get to the documentation.

vmg commented 13 years ago

/cc @schacon on this.