Solved

Doxygen error with constructor generated

Posted on 2014-01-14
2
430 Views
Last Modified: 2014-01-15
Experts,

I'm using Doxygen to generate doc files for Java classes that are organized in an Eclipse project.  Doxygen appears to run without any problems, but the doc page for classes in the project includes an error in the section that lists the constructor.

Here's an example of what the problem looks like.  Say the project is part of the following package:

  org.foo.bar

The name of a class in the project is this:

  MyClass

So the full name of the class would be this:

  org.foo.bar.MyClass

In the result file Doxygen produces for 'MyClass', the very first section has this:

---------
  Public Member Functions

   MyClass ()
---------

So far, so good -- this looks fine.  But the next section has the problem:

---------
  Constructor & Destructor Documentation

   org.foo.bar.MyClass.MyClass ()
---------

Here the class name is included *twice* in the full name listing, almost as if it's there once as part of the package name and then again, filling the role of class name.  This, of course, would not compile.  It's a real shame, since otherwise, the results Doxygen produced look pretty good.  And, it was fast, easy, and free to do this, so I don't want to complain too loudly about this.

Has anybody else had this problem with Doxygen?  For there to be any errors in the results, I would not have guessed it would be with the constructor!

Any thoughts?

Thanks.

Andy
0
Comment
Question by:aedolbey
[X]
Welcome to Experts Exchange

Add your voice to the tech community where 5M+ people just like you are talking about what matters.

  • Help others & share knowledge
  • Earn cash & points
  • Learn & ask questions
2 Comments
 
LVL 6

Accepted Solution

by:
Mahesh Bhutkar earned 500 total points
ID: 39781940
That's the way Doxygen generates documentation for Constructors. It treated as member function of the class it self.

You can checkout for some workaround using DoxygenLayout.xml (like visible=yes/no).

Otherwise you have dig into it's source code & modify the way you want.
you can get the source code from here,
http://www.stack.nl/~dimitri/doxygen/download.html
0
 

Author Closing Comment

by:aedolbey
ID: 39782474
Fair enough that the constructor would be presented in a fuller form, but make sure the result would actually work!  This guy would compile:

  MyClass myClassTok = new org.foo.bar.MyClass ();

The form given would not work:

  MyClass myClassTok = new org.foo.bar.MyClass.MyClass ();  // won't compile!

Rather than futzing around with DoxygenLayout or Doxygen source code, an even faster solution would be just to manually correct in the result the one item with the mistake.
0

Featured Post

Technology Partners: We Want Your Opinion!

We value your feedback.

Take our survey and automatically be enter to win anyone of the following:
Yeti Cooler, Amazon eGift Card, and Movie eGift Card!

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

This article will show, step by step, how to integrate R code into a R Sweave document
Whether you’re a college noob or a soon-to-be pro, these tips are sure to help you in your journey to becoming a programming ninja and stand out from the crowd.
Viewers will learn how to properly install Eclipse with the necessary JDK, and will take a look at an introductory Java program. Download Eclipse installation zip file: Extract files from zip file: Download and install JDK 8: Open Eclipse and …

756 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question