doxygen-users

[Doxygen-users] \copydoc warning - target of \copydoc command not found

[didje <dia...@pd...>]

I have hundreds (almost one thousand!) of \copydoc statements which are
producing the following warning message.
Warning: target testClassX::innerClassX::getYes() of \copydoc command not
found

Here is the situation.
There is a C++ class, called testClassX.cpp
Here are its contents:

// Start testClassX.cpp

namespace abc {

namespace def {
class testClassX::InnerClassX {
  /*! \brief blah blah
   * \details prints stuff out
   */
  void printIt() {
	printStuff();
    }
  
  bool getYes() {
	return true;
   }
}

    testClassX::testClassX() {
        innerClassX_ = new InnerClassX;
    }

    /*! \copydoc testClassX::InnerClassX::printIt() */
    void testClassX::printIt() {
        innerClassX_->printIt();
    }

    /*! \copydoc Catalog::Impl::load() */
    bool testClassX::getYes() {
        return InnerClassX_->getYes();
    }

}
}

// End testClassX.cpp


The above example, when run through doxygen, yields:

Warning: target testClassX::innerClassX::getYes() of \copydoc command not
found
(However, there is no warning message for printIt(). Is this because it does
not return any parameters?)

Note that the class testClassX is declared in the .h file. 

What is wrong in the above example? How can I get rid of those \copydoc
related warnings?



--
View this message in context: http://doxygen.10944.n7.nabble.com/copydoc-warning-target-of-copydoc-command-not-found-tp6345.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] \copydoc warning - target of \copydoc command not found

[didje <dia...@pd...>]

Here is an exchange of mails I had on the above problem, which did not
unfortunately, resolve it:

Hi Arthur
I tried removing the outer class specification, but unfortunately that did
not work, as you thought.
Well, that's not quite true - bizarrely it worked for a method with a return
type of void...but not for the other methods, don't ask me why...
Diarmuid

Hi Diarmuid;

Nope. Don't think that there is anything wrong with the statement and the
return argument (seems to) have no relevancy. Can't say that I've helped
much but here is a copydoc from my code. Seems about the same as yours
except that I'm not referencing an inner class. I suppose that you might
want to remove the outer class specification and see if that improves
things, but I don't think that that should work.


    /** @copydoc SlipCellBase::remove() */

art

Hi Arthur,
Thanks for your reply.
No, I did not mean class testClassX : innerClassX.
The example I gave is direct from the code.
testClassX is not a namespace, it is a class. It is declared in a .h file.
The code I supplied is from the corresponding .cpp file.
Diarmuid

Did you mean "class testClassX : innerClassX {"? Where is the namespace
testClassX defined?

art




--
View this message in context: http://doxygen.10944.n7.nabble.com/copydoc-warning-target-of-copydoc-command-not-found-tp6345p6352.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] \copydoc warning - target of \copydoc command not found

[didje <dia...@pd...>]

I discovered the solution to this problem.
I set following properties in the doxyfile to YES and, hey presto, copydoc
statements found the inner classes:

EXTRACT_ALL           = YES
EXTRACT_PRIVATE       = YES
EXTRACT_STATIC        = YES

I think EXTRACT_STATIC was not necessary to fix this, but I needed it for
another (unrelated) reason.





--
View this message in context: http://doxygen.10944.n7.nabble.com/copydoc-warning-target-of-copydoc-command-not-found-tp6345p6356.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.