Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Why is Doxygen so unfriendly to mobiles?

Doxygen seems to be the number one choice for code documentation in C++ (and many other languages) but every time I browse Doxygen generated doc from my phone, the site literally does not scroll, text is horribly small ...

How come ?

I come from python/sphinx, and sites like readthedocs.org manage perfectly mobile friendliness in the HTML generation (IMO), whereas the most popular documentation system around can't ? I must be missing something.

I tried looking around the interwebs for some HTML theme minimising problems, but no one even mentions the pain of trying to browse API references from a phone (yes, I do that :p)

Anyone experience the same problems or has a solution / workaround ?

Ps: Try Google mobile friendliness test on doxygen API sites like this intro to Doxygen, generated with Doxygen

EDIT [2017] : Seems Doxygen is getting better, the link in question is now "fully compatible with mobile" according to the quoted google tool. Thanks to everyone in the community making things better !

like image 968
Jiby Avatar asked Jun 20 '15 14:06

Jiby


People also ask

What is Doxygen used for?

This medication is used to treat a wide variety of bacterial infections, including those that cause acne. This medication is also used to prevent malaria. This medication is known as a tetracycline antibiotic. It works by stopping the growth of bacteria.

What is Doxygen style?

Doxygen (/ˈdɒksidʒən/ DOK-see-jən) is a documentation generator and static analysis tool for software source trees. When used as a documentation generator, Doxygen extracts information from specially-formatted comments within the code.

What is Doxygen C++?

Doxygen is a tool that can generate project documentation in html, pdf or Latex from code comments formatted with Doxygen markup syntax. The generated documentation makes easier to navigate and understand the code as it may contain all public functions, classes, namespaces, enumerations, side notes and code examples.


1 Answers

There is a project on github called doxygen-bootstrapped using bootstrap for doxygen documentation, making it much more mobile friendly. See this demo.

The demo is marked as mobile-friendly by your link

like image 80
spoorcc Avatar answered Sep 28 '22 17:09

spoorcc