Jump to content

Offline API documentation tool


AggrorJorn
 Share

Recommended Posts

Can anybody recommend a tool for creating CHM/Offline documentation?

 

I am currently working with a PDF file which is just not that useful when dealing with API and code snippets. Another possibility would creating an offline website like a wiki or custom website, but CHM would be nice too.

 

All your thoughts are are welcome.

Link to comment
Share on other sites

There are a few different API documentation generators that might work. One tool called Doxygen is nice. It generates linked HTML pages. If you write the function prototypes out, then you can generate the documentation with this. This tool is nice because it preserves class hierachy.

 

But this would force you to write out every function prototype in Leadwerks. You could scrape the Leadwerks API pages though and write the relevant information in a .h file and then compile that file with Doxygen.

Link to comment
Share on other sites

Oh ok. I mean you can still use Doxygen though, that's what it's designed to do. You just put a few comments in your code and the documentation gets generated for you. You can even change the styling of the HTML pages that are generated. There's a few extensions in other languages such as Lua in case that's what you were after.

  • Upvote 1
Link to comment
Share on other sites

  • 1 month later...

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

 Share

×
×
  • Create New...