DoxyS, advanced free C++ documentation tool

No, Doxys is installed on my main drive. I am running a RAID 1 (Mirror)configuration though.

I really like what this tool is doing for me. However, I've one problem I can't figure out. I'm documenting a typical function in the following manner:

/**
Enable or disable the window's menu.
EnableMenu enables or disables the window's menu and submenus.
*/
void cWindow::EnableMenu(HMENU _hMenu, ///< The menu to enable
bool _Enable) ///< #true# to enable
{
if (_hMenu==GetMenu())
SetMenu(_hMenu);
}

In the generated documentation, I get the parameter description repeated. The parameter list will be correct, but I will see "The menu to enable The menu to enable" in the description.

Any ideas what I'm doing wrong? Can I give you any more information?

Hi Doxy's

I haven't tried your tool yet, but the screenshots turned me on Cool | :cool:

- so I want to know a bit more about the project and its future before i commit myself to using the tool.

What's the future plans of this project? I can see that there is a lot of things to do
http://www.doxys.dk/doxys_homepage/homepage/Project_Status/FeaturesTodo0_page_description.html

But how dedicated are you? Are you willing to commit to the future development that is needed to keep this project alive? Is this going to evolve into a commercial product at some time? What about donations?

One important issue is IDE integration - do you have any plans in that department? I've tried using a webbrowser on the side, but it's not the same as something that is integratet - like Eclipse and Javadoc.

Last but not least, its nice to see a project from DK here Smile | :)

/Markowitch

First: Thank you Smile | :)

Well try it out. It's very easy to use. Just place yourself in the root of your code directory and type 'doxys'. Assuming you placed doxys and dot executebles somewhere in your path.

As for the commited thing:
We are very committed both of us and will continue to develop DoxyS. We have been working quite hard for 1½ years to get to where we are now, but we still have lots of ideas Smile | :)

. Also we wish it to become as stable and reliable as possible!

IDE integration:
We do have some IDE integration for VS.NET, and Bobby Michalca has promised to make an even tighter form of integration to VS.NET (I'm not sure actually what this exactly mean though).
We plan to make tools to help you actually write the documentation via plugins for various editors. But if it's just about being able to access documentation from the IDE, we so far only have it for VS.NET. We would very much like to have it for other editors, but we would probably need some help from you people out there in order to do that Smile | :)

Maybe you can elaborate a little on what you mean when you say IDE integration or perhaps you can even help in implementing it .. either by doing it yourself or a least educate us howto make IDE integration for Eclipse if thats the one you want support for. Making the XML file for .NET integration was not that hard, and the class doing it should make a good stating point for others like it.

Regards The DoxyS team (Martin Harring & Martin Lütken)

Doxys can generate the Html Help projects for you. Also there are some settings to make doxys look more like MSDN (no menu on left side, etc).

After that all you have to do is call hhc to generate .chm file. More details on will be available with the next release help.

.

modified 17-May-14 11:59am.

Well thanks a lot Smile | :)

I don't think we quite understand what you mean ??? Ofcourse we have used DoxyS to generate our own documentation ... It is a documentation program after all!

Perhaps you refer to the HowtoDocument class/example, and perhaps you are right about that, but on the other hand other people have found it to be quite illustrative. We perhaps could also make a more normal approach with plain pages describing how to document code.

I suppose it's not the other pages like fx. this one:
http://www.doxys.dk/doxys_homepage/homepage/Documentation/Documenting/Documentingthecode0_page_description.html

that you don't find readable ???

Regards the DoxyS team (Martin Harring & Martin Lütken)

Thanks for a great tool! Very impressive.

In using doxys for C++ .NET code, the __gc specifier seems to confuse the way variables are identified. I get multiple variables all called __gc (but hiding their real name) in the output listing.

I built a filter to strip out 'whitespace __gc' then set up the doxys control file to pass the
input through that filter (wonderful feature!). This works in that all the variables are now properly listed in the output, but I have problems when using array specifiers. The variable is listed just as a scalar.

For example: int a __gc[];

is run through the filter, producing: int a[];

In the documentation, the variable is described as int a
with no mention that it is an array.

Is this correct or the way it's supposed to work?

-- Tom

Hi Tom

We are very happy that you like it Smile | :)

I was not familiar with the _gc specifier, but I've found out now what it does. But actually I don't think it has anything to with your problem. It seems to be general: Meaning that I think that a variable which is an array is not listet in the documentation as being an array, which of course is an error, and I'll put it on our todo list immidately!

Regards the DoxyS team! (Martin Harring and Martin Lütken)

Great tool = 5! Do you plan to add CHM (help file) generation support?

Thanks, we are very happy to hear that you like our work.

In the next release of DoxyS you will find support for chm files, thanks to Bobby Michalca.

Version 0.84b will be release around 20. march 2005

Kind regards
The DoxyS team (Martin Harring & Martin Lütken)

I have tried quite a few documentation tools and for the most part I have found that they take quite a bit of tweaking to get reasonable output. I installed doxyS and executed it from my projects source and without any tweaking I got my documentation. One of the things I like the most is that the documentation is in the one html page per member function. The integrated search and inheritance graphs are also very good and I did not have to do any work at all to get them.

Thank You for releasing this to GPL,
John

Hello,

After test in my big project (>2700 source files > 52 MB source code) I must say: VERY NICE AND GOOD. You get a rating of 5 from me. Nevertheless I have some hints or ideas, the make DoxyS better:

- In each directory you generate a file "arial.ttf". In my project is there a sum of 142 files with 43 MB. And I can not found any code snippet, that use this arial.ttf Sleepy | :zzz:

- Have you think about the idea, to build a database with all informations and generate the website's dynamical instead of static html-files? In this case, I think, you can decrease the complete result set (>1GB !!! in my project), because you don't need all informations redundant. If you want, I can help you to design the database struct Smile | :)

. Maybe this is also better to solve my next idea:

- I good an fast way to update all, if I have made some changes in source code. To generate all help files for my project I wait 1,5 hours !!! on a P4-3000 with 1GB RAM.

- Maybe it's a better solution, to put some javascript code in the HTML-files, to show some source code instead to put the source code in the html files direct. The javascript code can load the source direct from source file.

- I have seen, that you parse "normal and old web projects with javascript code". What's about web projects written in VB.NET? Here you have classes, methods and members too. Please support ASP.NET! This would be a nice feature.

Best regards
Stephan

Hi Stefan.
Thanks for the nice words about DoxyS.

The "arial.ttf":
Dot, the external program for making all the graphs, is using the font. For every directory we want to run dot in, we need the font file Frown | :-(

We are aware of the problem, and will fix it!
At the end of the documentation process DoxyS should remove all the fonts again.

The database:
It's a very good idea to put things in a database. It will save a whole lot of time when creating the documentation.
We would very much like your help to make the database.
Please write to doxys@doxys.dk so we can arrange something.

Reading the data from Javascript:
You are right, it takes up a lot of space!
All source files is parsed and made linkable form the c++ code. Therefore it will be very problematic/imposible to read it up as you click on the link.
To do this, it will requre some kind of user rights for the script to access the code files.
The code and the documentation will easily get out of synch.

DoxyS is made to easy to use. Unzip, generate and click on the link. That's the reason for making it in HTML, but an option for database output will be fantastic.

Please elaborate on the last part:
"- I have seen, that you parse "normal and old web projects with javascript code". What's about web projects written in VB.NET? Here you have classes, methods and members too. Please support ASP.NET! This would be a nice feature."

Kind regards
The DoxyS team (Martin Harring & Martin Lütken)

Hello DoxyS team!

In the last part I mean the following:
A part of my project is a website. The old version of this site is written for IIS-ASP with JavaScript for server- and client site code. Since last year I convert the webproject to ASP.NET with VB.NET on server site and JavaScript on client site.
I have seen, that doxys parse all the old website code and produce html documentation files. Now I think it's I good feature, that doxys can parse .NET-Webproject too. In my case, parse VB.NET classes with members, methods, constants and so on.

To my offer, to help you to design a database:
First I need detailed informations about your actual directory design. Which files with which name scheme you generate. Which informations exist in each file type and which informations in the files are redundatn in other files. You can contact me about stephan.pilz@stephan-pilz.de

If we create a database and a website, the result is, that a local webserver produce the output. In this case there is no problem to load a file from local hard disk into memory. This solves the problem with access rights in javascript. All things makes the local webserver. IIS is included in W2K, WXP, ...

Kind regards
Stephan

I tried it on a fairly large project (300K lines) and I got:

qgarray.cpp, line 387: out of memory error

My system has 768MB, and it took it all (peaked at 650mb) !!!

Also, does there really need to be so much command line output. Perhaps a HTML page for all the errors would be better.

Hi
About the command line output. We are planning to make HTML pages with warnings, errors, and all kinds of statistical information. And when we have done that we probably should add some more quiet run modes .. Smile | :)

Good suggestion ..

About the out of memory problem, we would vere much like to be able to recreate it. Is your code proprietary or is it possible for us to have a copy of it so we can get the bug fixed ?

Anyway you can email me at ml@doxys.dk

Regards Martin Lütken

Have you tried to change virtual memory settings (if you're using Windows).
It should be possible to get up to 3 GB og virtual memory! It might help.
Of course we will at some point look deeper into DoxyS's memory consumption Smile | :)

Regards DoxyS team

What is the difference between this and Doxygen?
The UI ouput is different, what other differences are there?

Confused | :confused:

I am the handsome one in the crowd.

Mainly these points I guess:

# Generated output reflects the code directory structure.
# Layers of abstraction with heavy use of overview tables providing names and brief descriptions of classes, functions etc. Inspired by Microsoft documentation.
# Wiki like syntax for writing directory level documentation and related documentation pages or even design documents.
# Built in incremental search engine (javascript).
# Mouse over effects on diagrams to provide additional information.
# Strong support for templates, ennumerations and overloaded functions.
# Professional output with consistent placement of special sections like: Note, See Also, Examples etc.

Is that answer enough?

Regards Martin Lutken

Ive just had a quick play with this and it rocks! Gets my 5! Smile | :)

Good work.

ade me;
while(myKitchen.beerInFridge()) {
me.watchTV();
me.consumeBeer(myKitchen.getBeerCan());
}

What is wrong with that?

Best regards,
Paul.

Jesus Christ is LOVE! Please tell somebody.

Well, because we had our very own ideas on hoe to make a doc-tool, which is quite different from Doxygen. But Doxygen has a great C++ parser which we are are using (improved it a bit to support overloads and template specializations better).

Regards Martin and Martin

The least you could have done was to give credit to Doxygen somewhere in your article.

DoxyS, advanced free C++ documentation tool

Introduction

Main features

Other key features

Screenshots

License

Comments and Discussions