API Reference CHM?

[vchamp]

Does anybody know where I can find a CHM version of API_Reference.pdf, if such exists? The PDF if very inconvenient for fast searching.

Thanks.

 

[computerex]

Does anybody know where I can find a CHM version of API_Reference.pdf, if such exists? The PDF if very inconvenient for fast searching.

Thanks.

Unfortunately I don't think one exists, however this will make reading pdfs much faster: http://downloads.foxitsoftware.com/foxitreader/FoxitReader22_setup.exe

 

[martins]

In the next version, the API documentation will be doxygen-generated, which produces both PDF and CHM output (including convenient cross-references, tables, etc). Unfortunately it is a bit tedious to write doxygen comments for hundreds of API functions, so I tend to only do them when I run out of other stuff to do (which rarely happens). At the current rate, the documentation will be complete in a few years time.

 

[Urwumpe]

Martins: I know the problem...

Usually, I comment most of the software I make on a concentrated doxygen-making day, instead of commenting it directly while writing the functions - which would be better. Usually I only comment those functions directly while developing, where I want to leave notes for myself... and these notes are rarely understandable for others...:sorry:

 

[jarmonik]

I just installed doxygen a week ago and I'm still trying to learn how to use it. My intention was to release a development tools for the latest multibody predictor that I am working on. I was hoping that doxygen would solve the documentation problem, atleat when making changes in a code those should be automatically updated in documenatation.


BTW, What are you developping, Urwumpe ? I haven't found any links.

 

[Urwumpe]

BTW, What are you developping, Urwumpe ? I haven't found any links.

Mostly on university, but I also do some tiny fun stuff at home, which I document with doxygen.

The old sources of the SDHLV are for example documented quickly in doxygen:

http://www-public.tu-bs.de:8080/~y0021684/SDHLV110/html/

I currently also try to program a tiny Roguelike using IrrLicht, but my gaming experience is still pretty limited.

 

[vchamp]

Unfortunately I don't think one exists, however this will make reading pdfs much faster: http://downloads.foxitsoftware.com/foxitreader/FoxitReader22_setup.exe

Thank you, computerex, for the link. It is really much better than Acrobat Reader. However, I decided to make the chm by myself. I think it will be more convenient to use it than pdf.

 

[vchamp]

Here is a self made chm:
View attachment API_Reference_chm.zip

 

[Notebook]

vcamp, I've extracted the file, but I get a
Navigation to the webpage was canceled

on opening, and

The address is not valid

on other pages.

Any ideas?

N.

 

[vchamp]

If you can't view the chm, try solutions described here:
http://weblog.helpware.net/?p=36

or here:
http://www.msghelp.net/showthread.php?tid=67001&page=1

Best regards.

 

[Notebook]

Unblocking the file in the properties page did the trick!

Very useful program.

Many thanks,

N.