Author Topic: Doxygen script plugin  (Read 47734 times)

Offline jomeggs

  • Multiple posting newcomer
  • *
  • Posts: 92
Doxygen script plugin
« on: April 11, 2008, 06:45:28 pm »
Hi,

recently, i thought about a doxygen plugin for automated documentation generation. After loading the CB source I saw, that you are using the gcc 4.x and that I've little knowledge about your sdk and...  :shock:

I'm a bit short of time, so I wrote a script. Maybe it's useful for someone here. It generates documentation for the currently activated project. Further details (installation, usage, output...) you'll find in the attached file.

Changelog version 04 (15.03.2009)
  • menue entries changed for Chinese users (nanyu and friends...)
  • CHM file is executed after generation for windows systems only
  • removed menue entry "Generate documentation with dependants", it's not working currently
  • proper error message when no active project has been opened as yet



[attachment deleted by admin]
« Last Edit: July 08, 2009, 12:44:35 am by jomeggs »

Offline JGM

  • Lives here!
  • ****
  • Posts: 518
  • Got to practice :)
Re: Doxygen script plugin
« Reply #1 on: April 11, 2008, 07:57:03 pm »
interesting!  :D

Offline jomeggs

  • Multiple posting newcomer
  • *
  • Posts: 92
Re: Doxygen script plugin
« Reply #2 on: April 13, 2008, 12:57:52 am »
interesting!  :D

Yes, and it works! At least for me... :lol:

If anyone tried it with linux, please tell me!

Offline pasgui

  • Almost regular
  • **
  • Posts: 165
    • LGP
Re: Doxygen script plugin
« Reply #3 on: April 13, 2008, 11:47:51 am »
If anyone tried it with linux, please tell me!

It works for me on Ubuntu Gutsy. Just a little bit surprise by the German language, but good documentation included in the script file.

Good job.

Best regards, pasgui
« Last Edit: April 13, 2008, 11:55:22 am by pasgui »

Offline jomeggs

  • Multiple posting newcomer
  • *
  • Posts: 92
Re: Doxygen script plugin
« Reply #4 on: April 13, 2008, 04:00:21 pm »
Just a little bit surprise by the German language, ...

Huh? I wrote the documentation in my cripple english, what the hell is...?! :shock:
Ah, there! The generated documents were produced in german!

I changed that 8)
« Last Edit: March 15, 2009, 02:53:22 pm by jomeggs »

Offline rhf

  • Multiple posting newcomer
  • *
  • Posts: 123
Re: Doxygen script plugin
« Reply #5 on: April 13, 2008, 06:01:54 pm »
jomeggs,

Just last week I committed to using Doxygen for one of my major projects, so I was very interested to try out your script plugin.  I am pleased to say that it worked very well for me on Windows XP, and I plan to use it a great deal.

I do have one question. Can the script be modified so that Doxygen will process dependency projects for the active project in the workspace?  Note: I am not sure this is necessary or even a good idea, but I was curious if you had thought about it.

Thanks for a nice CB addition!

Bob

Offline jomeggs

  • Multiple posting newcomer
  • *
  • Posts: 92
Re: Doxygen script plugin
« Reply #6 on: April 13, 2008, 07:01:03 pm »
Hi Bob,

I had a look to the CB scripting commands wiki and found the function call "GetDependenciesForProject()". If this works as expected, it could be done. As a simple solution, I can implement a new menu entry, which generates documents for the current active project and all it's dependants. But, for each project, you will get it's own documentation.

It would be a bigger task, to write a centralized document, which includes information for all of these projects.


Offline rhf

  • Multiple posting newcomer
  • *
  • Posts: 123
Re: Doxygen script plugin
« Reply #7 on: April 13, 2008, 07:32:07 pm »
But, for each project, you will get it's own documentation.
It would be a bigger task, to write a centralized document, which includes information for all of these projects.

Hmm. I see what you mean. I am not sure that I am really using the project dependencies correctly anyway. Maybe it is just simpler to add the various files directly into each project.

Thanks.

Offline jomeggs

  • Multiple posting newcomer
  • *
  • Posts: 92
Re: Doxygen script plugin
« Reply #8 on: April 13, 2008, 08:00:30 pm »
The most common use of dependencies is, if they are libraries or dll's which your project needs.

Offline er

  • Multiple posting newcomer
  • *
  • Posts: 34
Re: Doxygen script plugin
« Reply #9 on: April 14, 2008, 03:27:19 am »
Hello,

I am a newcomer to CB.

I have a related (i think) question:

Is it possible to set up CB to automatically generate Doxygen code, at the start of each source file? Such as:

/*
 * main.c
 * Copyright (C) Author Year <email>
 *
 * main.cpp is free software.
 *
 * You may redistribute it and/or modify it under the terms of the
 * GNU General Public License, as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * etc...
 *
 */
Code::Blocks 10.05/ Mac OS X 10.6.4/GCC

Offline jens

  • Administrator
  • Lives here!
  • *****
  • Posts: 7265
    • Jens' unofficial debian-repository for the Code::Blocks - IDE
Re: Doxygen script plugin
« Reply #10 on: April 14, 2008, 07:20:10 am »
Hello,

I am a newcomer to CB.

I have a related (i think) question:

Is it possible to set up CB to automatically generate Doxygen code, at the start of each source file? Such as:

/*
 * main.c
 * Copyright (C) Author Year <email>
 *
 * main.cpp is free software.
 *
 * You may redistribute it and/or modify it under the terms of the
 * GNU General Public License, as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * etc...
 *
 */


I think "Settings -> Editor... -> Default code" is what you look for.
But it seems to be only for C/C++ users.

Edit:
By the way I don't think it's related to the doxygen script plugin, even if you would use it to create "doxygen comments".


Offline Ekinoks

  • Single posting newcomer
  • *
  • Posts: 7
Re: Doxygen script plugin
« Reply #11 on: June 11, 2008, 05:19:07 pm »
Jomeggs, Thank you for this script ! :D

It is very easy to use and very effective ! ^^

THANKS !

Offline jomeggs

  • Multiple posting newcomer
  • *
  • Posts: 92
Re: Doxygen script plugin
« Reply #12 on: June 11, 2008, 11:14:23 pm »
Jomeggs, Thank you for this script ! :D
You're welcome!

I've another one for WINDOWS users. It opens the generated chm-file automatically after generation.
« Last Edit: March 15, 2009, 02:54:00 pm by jomeggs »

Offline rockstar1707

  • Single posting newcomer
  • *
  • Posts: 4
Re: Doxygen script plugin
« Reply #13 on: December 22, 2008, 11:33:32 am »
One question. I found this script really useful, but I have problems with the non-ASCII characters. The documentation that I write contains Eastern European characters, which are not shown correctly in generated documentation.

My source files are encoded in UTF-8, and the codepage in the browser is set to UTF-8 encoding as well. Is there something that I could/should change in that script, or this is some limitation of Doxygen/Code::Blocks?

Offline jomeggs

  • Multiple posting newcomer
  • *
  • Posts: 92
Re: Doxygen script plugin
« Reply #14 on: December 22, 2008, 02:23:33 pm »
Hi rockstar1701,

maybe, it is enough to comment out the following line in the script:

Code: [Select]
// sText +=  _T("INPUT_ENCODING         = ISO-8859-1\n");
If not, please take a look to the doxygen dokumentation wich tells, that at least the windows binary uses UTF8 too. You should find the related configuration options here:http://www.stack.nl/~dimitri/doxygen/config.html#cfg_dot_fontname

Please have an eye on everything what has to do with "FONT" or "ENCODING" for the project options. As far as I know, doxygen uses libiconv.libwich supports a lot of encodings: http://www.gnu.org/software/libiconv/

Hope, this helps...