Documentation software

Posted By: 3dgs_snake

Documentation software - 02/15/11 08:20

Hi,

Does someone know the software used to create LBGUI documentation (perhaps the same software used for 3DGS). I want to create a documentation for a plugin and don't know what software to use.

Thanks in advance

Best regards.
Posted By: rojart

Re: Documentation software - 02/15/11 12:25

HTML Help Workshop
Posted By: WretchedSid

Re: Documentation software - 02/15/11 12:34

Oh please, use something different. chm sucks on so many levels.
Use Doxygen or something, please!
Posted By: rojart

Re: Documentation software - 02/15/11 12:56

question was related to chm format and not what you like, but btw I like pdf wink
Posted By: WretchedSid

Re: Documentation software - 02/15/11 13:59

I understood the question, thats why I mentioned something different.
Posted By: 3dgs_snake

Re: Documentation software - 02/16/11 06:16

Thanks for all your answers.
grin Ok then, I think I will use pdf for the documentation. I didn't knew that there are people who don't like chm grin.

Best regards.
Posted By: PadMalcom

Re: Documentation software - 02/16/11 15:07

Ich hab mal ein Tool geschrieben um Lite-C Code automatisch dokumentieren zu lassen, zu laden ist das ganze hier:

www.jofre.de/?page_id=17

Hoffe, das funktioniert, über die Coding Guidlines musst du dich in der Doku nochmal schlau lesen laugh
Posted By: darkinferno

Re: Documentation software - 02/16/11 15:39

whats wrong with chm ? i prefer it over pdf in almost every way
Posted By: Paul_L_Ming

Re: Documentation software - 02/18/11 15:49

Hiya.

I find PDF's better because I can annotate my own notes and whatnot into them. I can also print stuff (selections, certain pages, etc.) MUCH easier. From what I understand, chm requiers certain .dlls and, at least on Win7 x64, I've encountered problems where I can't open/read a chm because it's expecting some 32-bit dll that no longer is part of Win7...so I have to go on the net to find it, download it, put it in the right place, and hope that is the only one (more often then not it's two or three files I need...but I don't know that until I hit run and it says I need 123.dll...find, dl, install, run...nope, need 456.dll now...find, dl, install, run...nope, need 789.dll now...rinse, repeat.

Anyway, PDF's all the way. laugh
Posted By: FBL

Re: Documentation software - 02/18/11 15:53

I use Doxygen + HTML Help Workshop. chm is fine, but it's Microsoft, that's why some people must cry.

pdf is pretty much ugly, as it misses proper search functionality.
Anyway, with LateX installed, Doxygen can also export pdf.
© 2024 lite-C Forums