This forum has been archived. All content is frozen. Please use KDE Discuss instead.

What are .dox files?

Tags: None
(comma "," separated)
apeters
Registered Member
Posts
2
Karma
0

What are .dox files?

Tue Jun 03, 2014 4:01 pm
All the documentation included in the Eigen 3 distribution is in the form of .dox files. An extensive search of the internet, the Eigen website, and this forum has been inconclusive. Apparently doxygen can read them, but not display them. They are readable through a text editor without formatting. So just what is this mysterious .dox format and how are they best read?
jitseniesen
Registered Member
Posts
204
Karma
2

Re: What are .dox files?

Tue Jun 03, 2014 7:26 pm
The "make doc" command runs doxygen, which converts the .dox files and comments in the C++ source into HTML pages. The resulting output can be seen online at http://eigen.tuxfamily.org/dox-devel/ (for the development branch).
apeters
Registered Member
Posts
2
Karma
0

Re: What are .dox files?

Tue Jun 03, 2014 8:02 pm
Thank you! Perhaps it would be good to add those two sentences to an Eigen README file or the INSTALL file. Just sayin.


Bookmarks



Who is online

Registered users: Bing [Bot], claydoh, Google [Bot], rblackwell, Yahoo [Bot]