Author Topic: SDK documentation  (Read 7329 times)

Offline Freem

  • Almost regular
  • **
  • Posts: 219
SDK documentation
« on: July 19, 2011, 03:01:30 pm »
This question could seem a bit ridiculous, as with sources we can have virtually all the needed documentation.

But searching in sources to find functions is not really easy, at least for me (I'm not so good with C++ and not so experienced in reversing), so I tried to find something which look like a documentation of C::B's SDK but didn't find anything on forums.
I tried to generate it with doxygen and sources but, to be honest, didn't really find the content easier to read than sources.

I've searched on wiki too, but there is only some infos to make some basic plugins, an event list, a "short overview" and some hints like coding rules. (http://wiki.codeblocks.org/index.php?title=Developer_documentation, http://wiki.codeblocks.org/index.php?title=Code::Blocks_SDK_events, http://wiki.codeblocks.org/index.php?title=A_short_overview_about_Code::Blocks_architecture)

Maybe I miss something, this is why I finally decide myself to ask it, but I guess this question is not really bright:
Is there is something like an API documentation that can be used to dev plugins?

If not, how/where could I find something which could eventually help me to try to make one? (maybe some functions/classes could be really volatile, as other are not destined to evolve)
And, at last, do you think it could be useful? (I know that SDK is not constant, but I don't think it change everyday)

PS: I don't think that all my words are the best to say what I'm trying to say, so I apologize about any possible misunderstanding.

Offline oBFusCATed

  • Developer
  • Lives here!
  • *****
  • Posts: 12090
    • Travis build status
Re: SDK documentation
« Reply #1 on: July 19, 2011, 03:56:39 pm »
Hm, doxygen is the only thing we have, but I'm not sure we need anything else.
Maybe only some diagrams to describe the structure of the whole thing...

The best help is the source code, also for plugin writers the contrib plugins could be quite helpful.
Just find a similar plugin and dissect it, read the code and find what and how is done.

And you can always ask for help here in the forum, see the plugins dev subforum...
(most of the time I ignore long posts)
[strangers don't send me private messages, I'll ignore them; post a topic in the forum, but first read the rules!]

Offline MortenMacFly

  • Administrator
  • Lives here!
  • *****
  • Posts: 9508
Re: SDK documentation
« Reply #2 on: July 22, 2011, 09:25:54 pm »
Maybe I miss something, this is why I finally decide myself to ask it, but I guess this question is not really bright:
Is there is something like an API documentation that can be used to dev plugins?
Check back the download section at berlios. There you'll find also a CHM file with the SDK documentation here:
http://developer.berlios.de/project/showfiles.php?group_id=5358
Note that although it's not the latest SVN revsion, the interface should not have changed since.
Compiler logging: Settings->Compiler & Debugger->tab "Other"->Compiler logging="Full command line"
C::B Manual: http://www.codeblocks.org/docs/main_codeblocks_en.html
C::B FAQ: http://wiki.codeblocks.org/index.php?title=FAQ

Offline Freem

  • Almost regular
  • **
  • Posts: 219
Re: SDK documentation
« Reply #3 on: July 24, 2011, 03:36:06 pm »
Thanks for your 2 replies, I will try to make some experiments with plugins, and if I learn fast enough, trying to help with C::B