Code::Blocks Forums

Developer forums (C::B DEVELOPMENT STRICTLY!) => Development => Topic started by: takeshimiya on November 12, 2005, 04:53:46 pm

Title: Code::Blocks SDK Reference Manual for 1.0 RC2 WIP
Post by: takeshimiya on November 12, 2005, 04:53:46 pm: Hi! I've just build (after some time) the autogenerated documentation for the SDK 1.0 RC2!
This is a WIP, so many many things are left to document by mandrav or anyone with CVS access willing to do the task.

I've made four versions: CHM, HTML, PDF and man pages.
The CHM version even works with the Help Plugin! :D

(http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/chm1.png)

Screen::Shoots

CHM Version
(http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/chm1_resize.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/chm1.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/chm2_resize.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/chm2.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/chm3_resize.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/chm3.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/chm4_resize.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/chm4.png)

HTML Version
(http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/htm1_resize.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/htm1.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/htm2_resize.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/htm2.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/htm3_resize.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/htm3.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/htm4_resize.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/htm4.png)

PDF Version
(http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/pdf1_resize.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/pdf1.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/pdf2_resize.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/pdf2.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/pdf3_resize.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/pdf3.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/pdf4_resize.png) (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-screenshots/pdf4.png)

File::Downloads

File: Code::Blocks SDK Reference Manual CHM version (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-chm.zip)
Filesize: 4160 KB | Version: 1.0rc2
MD5 Hash: d83299743e3cc67d883fd718966055f1

File: Code::Blocks SDK Reference Manual HTML version (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-html.tar.bz2)
Filesize: 3191 KB | Version: 1.0rc2
MD5 Hash: afe400c34337b3ccfc714460cba01f94

File: Code::Blocks SDK Reference Manual PDF version (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-pdf.zip)
Filesize: 575 KB | Version: 1.0rc2
MD5 Hash: 65f10fa8c39dbfc23d7328d8726c57cf

File: Code::Blocks SDK Reference Manual man version (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-man.tar.bz2)
Filesize: 29 KB | Version: 1.0rc2
MD5 Hash: 22b47238d9365ef2b2375deb68deb37b

File: Code::Blocks SDK Reference Manual How to build the documentation (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-build_docs.zip)
Filesize: 67 KB | Version: 1.0rc2
MD5 Hash: 46c63dab1274db3955ea7354b947895f

Note:
A list of current gotchas to solve by the devs is in the BUILD.txt (http://www.xjapan.com.ar/downloads/cb/BUILD.txt) of How to build the documentation (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-build_docs.zip).

Thanks to all of those who document C::B and those who write articles in the WiKi!

Feel free to put in the Downloads section or wherever you want and let me think what do you think of it. (http://forums.codeblocks.org/Themes/default/images/post/cheesy.gif)
Title: Re: Code::Blocks SDK Reference Manual for 1.0 RC2 WIP
Post by: mandrav on November 12, 2005, 10:41:51 pm: Nice work :)
Title: Re: Code::Blocks SDK Reference Manual for 1.0 RC2 WIP
Post by: David Perfors on November 14, 2005, 09:19:02 am: Thanks, nice job.

Did you used the doxygen file in from the cvs? And did you made some changes in it?
Title: Re: Code::Blocks SDK Reference Manual for 1.0 RC2 WIP
Post by: Michael on November 14, 2005, 11:02:30 am: Hello,

Thank you very much for the nice and useful job you have done.

Best wishes,
Michael
Title: Re: Code::Blocks SDK Reference Manual for 1.0 RC2 WIP
Post by: takeshimiya on November 14, 2005, 03:32:28 pm: No, of course I didn't used the doxygen file in CVS.

I've used DoxyS (a Doxygen spin-off) for the CHM and HTML,
and Doxygen for PDF and man pages.

I never liked the Doxygen output for HTML, but I like the output produced by DoxyS.

If you want to build yourself the docs or change something, check the How to build the documentation (http://www.xjapan.com.ar/downloads/cb/codeblocks-1.0rc2_sdk-build_docs.zip)

Anyways, do you think the download links will be better in the Code::Blocks' downloads section, or the WiKi? Or another place?

PS: mandrav, what do you think of the gotchas I've written on BUILD.txt?
Title: Re: Code::Blocks SDK Reference Manual for 1.0 RC2 WIP
Post by: mandrav on November 14, 2005, 05:54:11 pm: Quote
PS: mandrav, what do you think of the gotchas I've written on BUILD.txt?

Documentation of the API will be improved right after we finish some major changes we 're currently in the middle of :)
Title: Re: Code::Blocks SDK Reference Manual for 1.0 RC2 WIP
Post by: takeshimiya on November 14, 2005, 07:59:38 pm: No problem :)
Title: Re: Code::Blocks SDK Reference Manual for 1.0 RC2 WIP
Post by: yop on December 02, 2005, 08:31:04 am: Nice work :) Built the docs yesterday with DoxyS and I'm using the help plugin. My life has just become easier ;)
Title: Re: Code::Blocks SDK Reference Manual for 1.0 RC2 WIP
Post by: arixion on March 16, 2006, 01:11:16 pm: it looks great so far...:D:D