Front Page › Forums › Documentation › Doxygen documentation
- This topic has 7 replies, 2 voices, and was last updated 13 years, 4 months ago by Markus.
-
AuthorPosts
-
January 12, 2011 at 6:14 pm #734903ibluesParticipant
Hi,
I’m trying to learn H3D. It would be nice to print the reference ( http://www.h3dapi.org/uploads/api/H3DAPI_2.1/docs/H3DAPI/html/namespaces.html )
if it is not too much to ask, whenever possible:
if you guys can generate a chm or pdf file. I know for some people, using the browser is a lot better, but I’m old school and I like the hard copy better.
thanks,
FranciscoJanuary 14, 2011 at 7:42 am #734912MarkusKeymasterI still have the setup used for generating the html doxygen documentation for the release, so I could try. I have no idea how it will look thought since I have never tried generating the documentation for latex (pdflatex) so I can not guarantee it looks good and I do not have a lot of time to spend on making it look good.
Still interested, or would you rather try to generate the documentation yourself? If you check out the correct release branch (not latest trunk since it will be a loooot of extra work for you) you will get the doxygen configuration files.
January 14, 2011 at 9:06 pm #734915ibluesParticipantHello,
I did try but I have never used doxygen. I think you can generate CHM and latex files. CHM may end up being better. It’s easy for me to get a chm and convert that into PDF for printing…
It would be nice since I like the hard copies.
Whatever you can do, I would be of great help.
thanks,
FranciscoJanuary 19, 2011 at 9:18 am #734928MarkusKeymasterI have uploaded a version now.
Note that it will most probably contain a lot of mistakes but maybe it is sufficient. If you want a nicer version you will have to generate it yourself.Please make a feature request in the bug database that future releases should also make it possible to download doxygen documentation in chm and or pdf forms from http://www.h3d.org (no need to include them in the actual release though).
See the downloads section. Did not want to put it on the documentation page since I am not satisfied with it.
http://www.h3dapi.org/modules/PDdownloads/viewcat.php?cid=26January 19, 2011 at 2:43 pm #734929ibluesParticipantHi,
thank you so much. I looks really nice.
I checked the h3dapi chm file.
It’s perfect.
Just to let you know , the “external” files are not displaying (probably not pointing to the right location.)
For example, in modules, you see that happen a lot.thank you,
FranciscoJanuary 25, 2011 at 8:47 am #734957MarkusKeymasterI noticed they are not pointing to the right location and I also noticed that the main page for H3DAPI says (HAPI) and vice versa for the HAPI.chm file. I did not have time to look into this though. The external modules are simply references into the other chm files, so the data is there.
January 25, 2011 at 8:48 am #734958MarkusKeymasterI noticed they are not pointing to the right location and I also noticed that the main page for H3DAPI says (HAPI) and vice versa for the HAPI.chm file. I did not have time to look into this though.
January 25, 2011 at 8:48 am #727421ibluesParticipant -
AuthorPosts
- You must be logged in to reply to this topic.